a 2d vector More...

#include "vector.h"

Collaboration diagram for ns3::Vector2D:

Public Member Functions
	Vector2D ()
	Constructor: (0.0, 0.0)

	Vector2D (double _x, double _y)

double	GetLength () const
	Compute the length (magnitude) of the vector.

double	GetLengthSquared () const
	Compute the squared length of the vector.

Public Attributes
double	x
	x coordinate of vector

double	y
	y coordinate of vector

Friends
double	CalculateDistance (const Vector2D &a, const Vector2D &b)
	Calculate the Cartesian distance between two points.

double	CalculateDistanceSquared (const Vector2D &a, const Vector2D &b)
	Calculate the squared Cartesian distance between two points.

bool	operator!= (const Vector2D &a, const Vector2D &b)
	Inequality operator.

double	operator* (const Vector2D &a, const Vector2D &b)
	Dot product operator.

Vector2D	operator* (const Vector2D &a, double b)
	Scalar multiplication operator.

Vector2D	operator* (double a, const Vector2D &b)
	Scalar multiplication operator.

Vector2D	operator+ (const Vector2D &a, const Vector2D &b)
	Addition operator.

Vector2D	operator- (const Vector2D &a, const Vector2D &b)
	Subtraction operator.

bool	operator< (const Vector2D &a, const Vector2D &b)
	Less than comparison operator.

std::ostream &	operator<< (std::ostream &os, const Vector2D &vector)
	Output streamer.

bool	operator<= (const Vector2D &a, const Vector2D &b)
	Less than or equal to comparison operator.

bool	operator== (const Vector2D &a, const Vector2D &b)
	Equality operator.

bool	operator> (const Vector2D &a, const Vector2D &b)
	Greater than comparison operator.

bool	operator>= (const Vector2D &a, const Vector2D &b)
	Greater than or equal to comparison operator.

std::istream &	operator>> (std::istream &is, Vector2D &vector)
	Input streamer.

Detailed Description

a 2d vector

See also: attribute_Vector2D

Definition at line 195 of file vector.h.

Constructor & Destructor Documentation

◆ Vector2D() [1/2]

ns3::Vector2D::Vector2D	(	double	_x,
		double	_y )

Parameters

[in]	_x	X coordinate of vector
[in]	_y	Y coordinate of vector

Create vector (_x, _y)

Definition at line 55 of file vector.cc.

References NS_LOG_FUNCTION.

◆ Vector2D() [2/2]

ns3::Vector2D::Vector2D ( )

Constructor: (0.0, 0.0)

Definition at line 62 of file vector.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetLength()

double ns3::Vector2D::GetLength ( ) const

Compute the length (magnitude) of the vector.

Returns: the vector length.

Definition at line 77 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 91 of file vector.cc.

References NS_LOG_FUNCTION, x, and y.

Friends And Related Symbol Documentation

◆ CalculateDistance

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

friend

Calculate the Cartesian distance between two points.

Parameters

[in]	a	One point
[in]	b	Another point

Returns: The distance between a and b .

Definition at line 105 of file vector.cc.

◆ CalculateDistanceSquared

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

friend

Calculate the squared Cartesian distance between two points.

Parameters

[in]	a	One point
[in]	b	Another point

Returns: The distance between a and b .

Definition at line 119 of file vector.cc.

◆ operator!=

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

friend

Inequality operator.

Parameters

[in]	a	lhs vector.
[in]	b	rhs vector.

Returns: true if a is not equal to b .

Definition at line 261 of file vector.cc.

◆ operator* [1/3]

double operator*	(	const Vector2D &	a,
		const Vector2D &	b )

friend

Dot product operator.

Parameters

[in]	a	lhs vector.
[in]	b	rhs vector.

Returns: The dot product of a and b .

Definition at line 291 of file vector.cc.

◆ operator* [2/3]

Vector2D operator*	(	const Vector2D &	a,
		double	b )

friend

Scalar multiplication operator.

Parameters

[in]	a	lhs vector.
[in]	b	rhs scalar.

Returns: The vector a scaled by b .

Definition at line 279 of file vector.cc.

◆ operator* [3/3]

Vector2D operator*	(	double	a,
		const Vector2D &	b )

friend

Scalar multiplication operator.

Parameters

[in]	a	lhs scalar.
[in]	b	rhs vector.

Returns: The vector b scaled by a .

Definition at line 285 of file vector.cc.

◆ operator+

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

friend

Addition operator.

Parameters

[in]	a	lhs vector.
[in]	b	rhs vector.

Returns: The vector sum of a and b .

Definition at line 267 of file vector.cc.

◆ operator-

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

friend

Subtraction operator.

Parameters

[in]	a	lhs vector.
[in]	b	rhs vector.

Returns: The vector difference of a and b .

Definition at line 273 of file vector.cc.

◆ operator<

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

friend

Less than comparison operator.

Parameters

[in]	a	lhs vector
[in]	b	rhs vector

Returns: true if a is less than b

Definition at line 230 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]	os	The stream.
[in]	vector	The vector to stream

Returns: The stream.

Definition at line 211 of file vector.cc.

◆ operator<=

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

friend

Less than or equal to comparison operator.

Parameters

[in]	a	lhs vector
[in]	b	rhs vector

Returns: true if a is less than or equal to b .

Definition at line 236 of file vector.cc.

◆ operator==

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

friend

Equality operator.

Parameters

[in]	a	lhs vector.
[in]	b	rhs vector.

Returns: true if a is equal to b .

Definition at line 255 of file vector.cc.

◆ operator>

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

friend

Greater than comparison operator.

Parameters

[in]	a	lhs vector
[in]	b	rhs vector

Returns: true if a is greater than b .

Definition at line 243 of file vector.cc.

◆ operator>=

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

friend

Greater than or equal to comparison operator.

Parameters

[in]	a	lhs vector
[in]	b	rhs vector

Returns: true if a is greater than or equal to b .

Definition at line 249 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]	is	The stream.
[in]	vector	The vector.

Returns: The stream.

Definition at line 219 of file vector.cc.

Member Data Documentation

◆ x

double ns3::Vector2D::x

x coordinate of vector

Definition at line 207 of file vector.h.

Referenced by visualizer.svgitem.SvgItem::do_get_property(), visualizer.svgitem.SvgItem::do_set_property(), visualizer.svgitem.SvgItem::do_simple_is_item_at(), visualizer.svgitem.SvgItem::do_simple_paint(), GetLength(), and GetLengthSquared().

◆ y

double ns3::Vector2D::y

y coordinate of vector

Definition at line 208 of file vector.h.

Referenced by visualizer.svgitem.SvgItem::do_get_property(), visualizer.svgitem.SvgItem::do_set_property(), visualizer.svgitem.SvgItem::do_simple_is_item_at(), visualizer.svgitem.SvgItem::do_simple_paint(), GetLength(), and GetLengthSquared().

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

src/core/model/vector.h
src/core/model/vector.cc

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Vector2D() [1/2]

◆ Vector2D() [2/2]

Member Function Documentation

◆ GetLength()

◆ GetLengthSquared()

Friends And Related Symbol Documentation

◆ CalculateDistance

◆ CalculateDistanceSquared

◆ operator!=

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator+

◆ operator-

◆ operator<

◆ operator<<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

◆ operator>>

Member Data Documentation

◆ x

◆ y