A Discrete-Event Network Simulator
API
ns3::Vector2D Class Reference

a 2d vector More...

#include "vector.h"

+ Collaboration diagram for ns3::Vector2D:

Public Member Functions

 Vector2D ()
 Constructor: (0.0, 0.0) More...
 
 Vector2D (double _x, double _y)
 
double GetLength () const
 Compute the length (magnitude) of the vector. More...
 
double GetLengthSquared () const
 Compute the squared length of the vector. More...
 

Public Attributes

double x
 x coordinate of vector More...
 
double y
 y coordinate of vector More...
 

Friends

double CalculateDistance (const Vector2D &a, const Vector2D &b)
 Calculate the Cartesian distance between two points. More...
 
double CalculateDistanceSquared (const Vector2D &a, const Vector2D &b)
 Calculate the squared Cartesian distance between two points. More...
 
bool operator!= (const Vector2D &a, const Vector2D &b)
 Inequality operator. More...
 
Vector2D operator+ (const Vector2D &a, const Vector2D &b)
 Addition operator. More...
 
Vector2D operator- (const Vector2D &a, const Vector2D &b)
 Subtraction operator. More...
 
bool operator< (const Vector2D &a, const Vector2D &b)
 Less than comparison operator. More...
 
std::ostream & operator<< (std::ostream &os, const Vector2D &vector)
 Output streamer. More...
 
bool operator<= (const Vector2D &a, const Vector2D &b)
 Less than or equal to comparison operator. More...
 
bool operator== (const Vector2D &a, const Vector2D &b)
 Equality operator. More...
 
bool operator> (const Vector2D &a, const Vector2D &b)
 Greater than comparison operator. More...
 
bool operator>= (const Vector2D &a, const Vector2D &b)
 Greater than or equal to comparison operator. More...
 
std::istream & operator>> (std::istream &is, Vector2D &vector)
 Input streamer. More...
 

Detailed Description

a 2d vector

See also
Vector2D Attribute

Definition at line 182 of file vector.h.

Constructor & Destructor Documentation

◆ Vector2D() [1/2]

ns3::Vector2D::Vector2D ( double  _x,
double  _y 
)
Parameters
[in]_xX coordinate of vector
[in]_yY coordinate of vector

Create vector (_x, _y)

Definition at line 64 of file vector.cc.

References NS_LOG_FUNCTION.

◆ Vector2D() [2/2]

ns3::Vector2D::Vector2D ( )

Constructor: (0.0, 0.0)

Definition at line 71 of file vector.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetLength()

double ns3::Vector2D::GetLength ( void  ) const

Compute the length (magnitude) of the vector.

Returns
the vector length.

Definition at line 85 of file vector.cc.

References NS_LOG_FUNCTION, x, and y.

Referenced by ns3::ThreeGppPropagationLossModel::GetShadowing().

+ Here is the caller graph for this function:

◆ GetLengthSquared()

double ns3::Vector2D::GetLengthSquared ( ) const

Compute the squared length of the vector.

Returns
the vector length squared.

Definition at line 98 of file vector.cc.

References NS_LOG_FUNCTION, x, and y.

Friends And Related Function Documentation

◆ CalculateDistance

double CalculateDistance ( const Vector2D a,
const Vector2D b 
)
friend

Calculate the Cartesian distance between two points.

Parameters
[in]aOne point
[in]bAnother point
Returns
The distance between a and b.

Definition at line 111 of file vector.cc.

◆ CalculateDistanceSquared

double CalculateDistanceSquared ( const Vector2D a,
const Vector2D b 
)
friend

Calculate the squared Cartesian distance between two points.

Parameters
[in]aOne point
[in]bAnother point
Returns
The distance between a and b.

Definition at line 124 of file vector.cc.

◆ operator!=

bool operator!= ( const Vector2D a,
const Vector2D b 
)
friend

Inequality operator.

Parameters
[in]alhs vector.
[in]brhs vector.
Returns
true if a is not equal to b.

Definition at line 225 of file vector.cc.

◆ operator+

Vector2D operator+ ( const Vector2D a,
const Vector2D b 
)
friend

Addition operator.

Parameters
[in]alhs vector.
[in]brhs vector.
Returns
The vector sum of a and b.

Definition at line 230 of file vector.cc.

◆ operator-

Vector2D operator- ( const Vector2D a,
const Vector2D b 
)
friend

Subtraction operator.

Parameters
[in]alhs vector.
[in]brhs vector.
Returns
The vector difference of a and b.

Definition at line 235 of file vector.cc.

◆ operator<

bool operator< ( const Vector2D a,
const Vector2D b 
)
friend

Less than comparison operator.

Parameters
[in]alhs vector
[in]brhs vector
Returns
true if a is less than b

Definition at line 200 of file vector.cc.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Vector2D vector 
)
friend

Output streamer.

Vectors are written as "x:y".

Parameters
[in,out]osThe stream.
[in]vectorThe vector to stream
Returns
The stream.

Definition at line 185 of file vector.cc.

◆ operator<=

bool operator<= ( const Vector2D a,
const Vector2D b 
)
friend

Less than or equal to comparison operator.

Parameters
[in]alhs vector
[in]brhs vector
Returns
true if a is less than or equal to b.

Definition at line 205 of file vector.cc.

◆ operator==

bool operator== ( const Vector2D a,
const Vector2D b 
)
friend

Equality operator.

Parameters
[in]alhs vector.
[in]brhs vector.
Returns
true if a is equal to b.

Definition at line 220 of file vector.cc.

◆ operator>

bool operator> ( const Vector2D a,
const Vector2D b 
)
friend

Greater than comparison operator.

Parameters
[in]alhs vector
[in]brhs vector
Returns
true if a is greater than b.

Definition at line 210 of file vector.cc.

◆ operator>=

bool operator>= ( const Vector2D a,
const Vector2D b 
)
friend

Greater than or equal to comparison operator.

Parameters
[in]alhs vector
[in]brhs vector
Returns
true if a is greater than or equal to b.

Definition at line 215 of file vector.cc.

◆ operator>>

std::istream& operator>> ( std::istream &  is,
Vector2D vector 
)
friend

Input streamer.

Vectors are expected to be in the form "x:y".

Parameters
[in,out]isThe stream.
[in]vectorThe vector.
Returns
The stream.

Definition at line 190 of file vector.cc.

Member Data Documentation

◆ x

◆ y


The documentation for this class was generated from the following files: