MipBaselib::Position3DArma Class Reference

#include <R3Arma.h>

Inheritance diagram for MipBaselib::Position3DArma:

List of all members.

Public Member Functions
	Position3DArma ()
	Default constructor.
	Position3DArma (const Decimal &x, const Decimal &y, const Decimal &z)
	Complete constructor.
	Position3DArma (const Position2DArma &xy, const Decimal &z)
	Complete constructor.
	Position3DArma (const Position3D &A)
	Copy constructor.
	Position3DArma (const Position3DArma &A)
	Copy constructor.
	Position3DArma (const arma::Mat< Decimal > &A)
	Copy constructor.
Position3DArma &	operator= (const Position3D &rhs)
	Assignment operator.
Position3DArma &	operator= (const Position3DArma &rhs)
	Assignment operator.
Position3DArma &	operator= (const arma::Mat< Decimal > &rhs)
	Assignment operator.
Position3DArma &	operator+= (const Position3DArma &pos)
	Compound assignment operator product by a another Position3DArma pos +=.
Position3DArma &	operator+= (const arma::Col< Decimal >::fixed< 3 > &pos)
	Compound assignment operator product by a another arma column vector pos +=.
Position3DArma &	operator+= (const Decimal &scalar)
	Compound assignment operator sum by a scalar +.
Position3DArma	operator- (Position3DArma &other) const
	Binary arithmetic operator element-wise Position3DArma.
Position3DArma &	operator-= (const Position3DArma &pos)
	Compound assignment operator product by a another Position3DArma pos -=.
Position3DArma &	operator-= (const Decimal &scalar)
	Compound assignment operator sum by a scalar +.
Position3DArma &	operator-= (const arma::Col< Decimal >::fixed< 3 > &pos)
	Compound assignment operator product by a another arma column vector pos +=.
Position3DArma	operator+ (Position3DArma &other) const
	Binary arithmetic operator element-wise Position3DArma.
Position3DArma &	operator*= (const Position3DArma &pos)
	Compound assignment operator product by a another Position3DArma pos *=.
Position3DArma &	operator*= (const Decimal &scalar)
	Compound assignment operator product by a scalar *.
Position3DArma &	operator*= (const arma::Mat< Decimal >::fixed< 3, 3 > &mat)
	Compound assignment operator product by a scalar *.
Position3DArma &	operator*= (const arma::Col< Decimal >::fixed< 3 > &vec)
	Compound assignment operator product by a scalar *.
Position3DArma &	operator*= (const Roto3DArma &mat)
	Compound assignment operator product by a scalar *.
Position3DArma &	operator*= (const arma::Mat< Decimal >::fixed< 4, 4 > &mat)
	Compound assignment operator product by a scalar * in homogeneous coordinate.
Position3DArma	operator* (Position3DArma &other) const
	Binary arithmetic operator element-wise scalar.
Position3DArma	operator* (const arma::Col< Decimal >::fixed< 3 > &vec)
	Compound assignment operator product by a scalar *.
Position3DArma &	operator/= (const Position3DArma &pos)
	Compound assignment operator product by a another Position3DArma pos *=.
Position3DArma &	operator/= (const Decimal &scalar)
	Compound assignment operator product by a scalar *.
Position3DArma &	operator/= (const arma::Col< Decimal >::fixed< 3 > &vec)
Position3DArma	operator/ (const arma::Col< Decimal >::fixed< 3 > &vec) const
	Binary arithmetic operator element-wise scalar.
Position3DArma	operator/ (Position3DArma &other) const
	Binary arithmetic operator element-wise scalar.
bool	operator== (const Position3DArma &other) const
	Operator ==.
Position3DArma	matrixProd (const arma::Mat< Decimal >::fixed< 3, 3 > &mat)
	Multiply the input matrix with actual element and overwrite it.
Position3DArma	matrixHomoProd (const arma::Mat< Decimal >::fixed< 4, 4 > &mat)
	Multiply the input matrix with actual element and overwrite it.
Position3DArma	matrixProd (const Roto3DArma &mat)
	Multiply the input matrix with actual element and overwrite it.
Decimal	x () const
	Return the x component.
Decimal	y () const
	Return the x component.
Decimal	z () const
	Return the x component.
void	setX (const Decimal &p)
	Set the x component.
void	setY (const Decimal &p)
	Set the x component.
void	setZ (const Decimal &p)
	Set the x component.
Angle	azimuth () const
	Compute the azimuth angle.
Angle	zenith () const
	Compute the zenith angle wrt z-axis.
string	print ()
	Print.
Decimal	norm (int p=2) const
	Norm of the vector.
Decimal	dist (Position3DArma &other, int p=2) const
	Compute the distance between two Position3DArma.
Position2DArma	getPosition2D ()
	Get the Position2D.

---

Constructor & Destructor Documentation

Position3DArma::Position3DArma

(

)

Default constructor.

Position3DArma::Position3DArma	(	const Decimal &	x,
		const Decimal &	y,
		const Decimal &	z
	)

Complete constructor.

Parameters:

[in]	&x	x coordinate
[in]	&y	y coordinate
[in]	&z	z coordinate

Position3DArma::Position3DArma	(	const Position2DArma &	xy,
		const Decimal &	z
	)

Complete constructor.

Parameters:

[in]	&xy	Position in 2D representing the xy coordinates
[in]	&z	z coordinate

Position3DArma::Position3DArma

(

const Position3D &

A

)

Copy constructor.

Position3DArma::Position3DArma

(

const Position3DArma &

A

)

Copy constructor.

Position3DArma::Position3DArma

(

const arma::Mat< Decimal > &

A

)

Copy constructor.

---

Member Function Documentation

Position3DArma & Position3DArma::operator=

(

const Position3D &

rhs

)

Assignment operator.

Position3DArma & Position3DArma::operator=

(

const Position3DArma &

rhs

)

Assignment operator.

Position3DArma & Position3DArma::operator=

(

const arma::Mat< Decimal > &

rhs

)

Assignment operator.

Reimplemented in MipBaselib::Velocity3DArma, and MipBaselib::Acceleration3DArma.

Position3DArma & Position3DArma::operator+=

(

const Position3DArma &

pos

)

Compound assignment operator product by a another Position3DArma pos +=.

Position3DArma & Position3DArma::operator+=

(

const arma::Col< Decimal >::fixed< 3 > &

pos

)

Compound assignment operator product by a another arma column vector pos +=.

Position3DArma & Position3DArma::operator+=

(

const Decimal &

scalar

)

Compound assignment operator sum by a scalar +.

Position3DArma Position3DArma::operator-

(

Position3DArma &

other

)

const

Binary arithmetic operator element-wise Position3DArma.

Position3DArma & Position3DArma::operator-=

(

const Position3DArma &

pos

)

Compound assignment operator product by a another Position3DArma pos -=.

Position3DArma & Position3DArma::operator-=

(

const Decimal &

scalar

)

Compound assignment operator sum by a scalar +.

Position3DArma & Position3DArma::operator-=

(

const arma::Col< Decimal >::fixed< 3 > &

pos

)

Compound assignment operator product by a another arma column vector pos +=.

Position3DArma Position3DArma::operator+

(

Position3DArma &

other

)

const

Binary arithmetic operator element-wise Position3DArma.

Position3DArma & Position3DArma::operator*=

(

const Position3DArma &

pos

)

Compound assignment operator product by a another Position3DArma pos *=.

Position3DArma & Position3DArma::operator*=

(

const Decimal &

scalar

)

Compound assignment operator product by a scalar *.

Position3DArma & Position3DArma::operator*=

(

const arma::Mat< Decimal >::fixed< 3, 3 > &

mat

)

Compound assignment operator product by a scalar *.

Position3DArma & Position3DArma::operator*=

(

const arma::Col< Decimal >::fixed< 3 > &

vec

)

Compound assignment operator product by a scalar *.

Position3DArma & Position3DArma::operator*=

(

const Roto3DArma &

mat

)

Compound assignment operator product by a scalar *.

Position3DArma & Position3DArma::operator*=

(

const arma::Mat< Decimal >::fixed< 4, 4 > &

mat

)

Compound assignment operator product by a scalar * in homogeneous coordinate.

Position3DArma Position3DArma::operator*

(

Position3DArma &

other

)

const

Binary arithmetic operator element-wise scalar.

Position3DArma Position3DArma::operator*

(

const arma::Col< Decimal >::fixed< 3 > &

vec

)

Compound assignment operator product by a scalar *.

Position3DArma & Position3DArma::operator/=

(

const Position3DArma &

pos

)

Compound assignment operator product by a another Position3DArma pos *=.

Position3DArma & Position3DArma::operator/=

(

const Decimal &

scalar

)

Compound assignment operator product by a scalar *.

Position3DArma & Position3DArma::operator/=

(

const arma::Col< Decimal >::fixed< 3 > &

vec

)

Position3DArma Position3DArma::operator/

(

const arma::Col< Decimal >::fixed< 3 > &

vec

)

const

Binary arithmetic operator element-wise scalar.

Position3DArma Position3DArma::operator/

(

Position3DArma &

other

)

const

Binary arithmetic operator element-wise scalar.

bool Position3DArma::operator==

(

const Position3DArma &

other

)

const

Operator ==.

Position3DArma Position3DArma::matrixProd

(

const arma::Mat< Decimal >::fixed< 3, 3 > &

mat

)

Multiply the input matrix with actual element and overwrite it.

Parameters:

[in]

&mat

3x3 matrix

Position3DArma Position3DArma::matrixHomoProd

(

const arma::Mat< Decimal >::fixed< 4, 4 > &

mat

)

Multiply the input matrix with actual element and overwrite it.

Parameters:

[in]

&mat

4x4 matrix

Position3DArma Position3DArma::matrixProd

(

const Roto3DArma &

mat

)

Multiply the input matrix with actual element and overwrite it.

Parameters:

[in]

&mat

3x3 matrix

Decimal Position3DArma::x

(

void

)

const

Return the x component.

Decimal Position3DArma::y

(

void

)

const

Return the x component.

Decimal Position3DArma::z

(

)

const

Return the x component.

void Position3DArma::setX

(

const Decimal &

p

)

Set the x component.

void Position3DArma::setY

(

const Decimal &

p

)

Set the x component.

void Position3DArma::setZ

(

const Decimal &

p

)

Set the x component.

Angle Position3DArma::azimuth

(

)

const

Compute the azimuth angle.

Angle Position3DArma::zenith

(

)

const

Compute the zenith angle wrt z-axis.

string Position3DArma::print

(

)

Print.

Decimal Position3DArma::norm

(

int

p = 2

)

const

Norm of the vector.

Parameters:

[in]

p

It assign the order of the norm

Decimal Position3DArma::dist	(	Position3DArma &	other,
		int	p = 2
	)			const

Compute the distance between two Position3DArma.

Parameters:

[in]	other	Other Position3DArm
[in]	p	Order of the norm

Position2DArma Position3DArma::getPosition2D

(

)

Get the Position2D.

Returns:

Position in 2D

---

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

• baselib/Spaces/R3Arma.h
• baselib/Spaces/R3Arma.cpp