Ang2Pim Class Reference
[Spaces]

Represents angles in [0,2*MPIm). More...

#include <S1m.h>

List of all members.

Public Member Functions
	Ang2Pim ()
	Default constructor.
	Ang2Pim (UCoordmm t)
	UCoordmm constructor.
	Ang2Pim (const Ang2Pim &rhs)
	Copy constructor.
Ang2Pim &	operator= (const Ang2Pim &rhs)
	Assigment operator =.
Ang2Pim &	operator+= (const Ang2Pim &a)
	Compound assignment operator +=.
Ang2Pim &	operator-= (const Ang2Pim &a)
	Compound assignment operator -=.
Ang2Pim &	operator*= (const Coordmm &d)
	Compound assignment operator *= with scalar.
Ang2Pim &	operator*= (const UCoordmm &d)
	Compound assignment operator *= with scalar.
Ang2Pim &	operator*= (const int &d)
	Compound assignment operator *= with scalar.
const Ang2Pim	operator+ (const Ang2Pim &other) const
	Binary arithmetic operator +.
const Ang2Pim	operator- (const Ang2Pim &other) const
	Binary arithmetic operator -.
const Ang2Pim	operator* (const Coordmm &d) const
	Binary arithmetic operator * with scalar.
const Ang2Pim	operator* (const UCoordmm &d) const
	Binary arithmetic operator * with scalar.
const Ang2Pim	operator* (const int &d) const
	Binary arithmetic operator * with scalar.
bool	operator== (const Ang2Pim &other) const
	Compound operator ==.
bool	operator!= (const Ang2Pim &other) const
	Compound operator !=.
UCoordmm	dCast () const
	Explicit casting to UCoordmm.
Coordmm	dCastPi ()
	Explicit casting to Coordmm in (-MPIm, MPIm].
Coordmm	dCastDeg ()
	Explicit casting to Coordmm in degrees [0, 360.0).
Decimal	dCastPiDecimal ()
	Explicit casting to Decimal in [0, 2*MP_I).
Coordmm	alDiff (const Ang2Pim &other)
	Algebric difference (in ]-PI,PI]).
Coordmm	ccwDiff (const Ang2Pim &other)
	Counter-clock-wise difference (in [0,2*PI[).
Coordmm	cwDiff (const Ang2Pim &other)
	Clock-wise difference (in ]-2*PI,0]).
bool	almostEqual (Ang2Pim A, Coordmm toll)
	Equal condition with a tollerance.
Ang2Pim	mean (const Ang2Pim &other)
	The same as ccwMean.
Ang2Pim	ccwMean (const Ang2Pim &other)
	Counter-clock-wise mean, i.e, mean angle in ]this, other].
Ang2Pim	cwMean (const Ang2Pim &other)
	Clock-wise mean, i.e, mean angle in ]other, this].
string	print ()
	Print function.
Friends
class	boost::serialization::access

---

Detailed Description

Represents angles in [0,2*MPIm).

Author:

Paolo Stegagno

Todo:

make this a derived class of S1

---

Constructor & Destructor Documentation

Ang2Pim::Ang2Pim

(

)

[inline]

Default constructor.

Ang2Pim::Ang2Pim

(

UCoordmm

t

)

[inline]

UCoordmm constructor.

Ang2Pim::Ang2Pim

(

const Ang2Pim &

rhs

)

[inline]

Copy constructor.

---

Member Function Documentation

Ang2Pim& Ang2Pim::operator=

(

const Ang2Pim &

rhs

)

[inline]

Assigment operator =.

Ang2Pim& Ang2Pim::operator+=

(

const Ang2Pim &

a

)

[inline]

Compound assignment operator +=.

Ang2Pim& Ang2Pim::operator-=

(

const Ang2Pim &

a

)

[inline]

Compound assignment operator -=.

Ang2Pim& Ang2Pim::operator*=

(

const Coordmm &

d

)

[inline]

Compound assignment operator *= with scalar.

compound assignment operator *=

Ang2Pim& Ang2Pim::operator*=

(

const UCoordmm &

d

)

[inline]

Compound assignment operator *= with scalar.

Ang2Pim& Ang2Pim::operator*=

(

const int &

d

)

[inline]

Compound assignment operator *= with scalar.

const Ang2Pim Ang2Pim::operator+

(

const Ang2Pim &

other

)

const [inline]

Binary arithmetic operator +.

const Ang2Pim Ang2Pim::operator-

(

const Ang2Pim &

other

)

const [inline]

Binary arithmetic operator -.

const Ang2Pim Ang2Pim::operator*

(

const Coordmm &

d

)

const [inline]

Binary arithmetic operator * with scalar.

binary arithmetic operator *

const Ang2Pim Ang2Pim::operator*

(

const UCoordmm &

d

)

const [inline]

Binary arithmetic operator * with scalar.

const Ang2Pim Ang2Pim::operator*

(

const int &

d

)

const [inline]

Binary arithmetic operator * with scalar.

bool Ang2Pim::operator==

(

const Ang2Pim &

other

)

const [inline]

Compound operator ==.

bool Ang2Pim::operator!=

(

const Ang2Pim &

other

)

const [inline]

Compound operator !=.

UCoordmm Ang2Pim::dCast

(

)

const [inline]

Explicit casting to UCoordmm.

Coordmm Ang2Pim::dCastPi

(

)

[inline]

Explicit casting to Coordmm in (-MPIm, MPIm].

Coordmm Ang2Pim::dCastDeg

(

)

[inline]

Explicit casting to Coordmm in degrees [0, 360.0).

Decimal Ang2Pim::dCastPiDecimal

(

)

[inline]

Explicit casting to Decimal in [0, 2*MP_I).

Coordmm Ang2Pim::alDiff

(

const Ang2Pim &

other

)

Algebric difference (in ]-PI,PI]).

i.e, other-this in in [0,2*PI[.

Parameters:

[in]

other

the Ang2Pim respect to it is computed the algebric distance

Returns:

the algebric distance respect to an angle, it is in [-PI,PI]

Coordmm Ang2Pim::ccwDiff

(

const Ang2Pim &

other

)

Counter-clock-wise difference (in [0,2*PI[).

i.e, other-this in in [0,2*PI[.

Parameters:

[in]

other

The other angle.

Returns:

in [0,2*PI[

Coordmm Ang2Pim::cwDiff

(

const Ang2Pim &

other

)

Clock-wise difference (in ]-2*PI,0]).

i.e, other-this in in ]-2*PI,0].

Parameters:

[in]

other

The other angle.

Returns:

in ]-2*PI,0]

bool Ang2Pim::almostEqual	(	Ang2Pim	A,
		Coordmm	toll
	)

Equal condition with a tollerance.

Parameters:

[in]	A	The Ang2Pim to be confronted with.
[in]	toll	The acceppted tollerance (rad).

Returns:

true if difference betwen Ang2Pi is less than the tollerance, false otherwise.

Ang2Pim Ang2Pim::mean

(

const Ang2Pim &

other

)

The same as ccwMean.

Parameters:

[in]

other

the Ang2Pim respect to it is computed the mean.

Returns:

An angle that is.

Ang2Pim Ang2Pim::ccwMean

(

const Ang2Pim &

other

)

Counter-clock-wise mean, i.e, mean angle in ]this, other].

if this == other, it is by definition this + MPIm.

Parameters:

[in]

other

The other angle.

Returns:

Mean angle in ]this, other].

Ang2Pim Ang2Pim::cwMean

(

const Ang2Pim &

other

)

Clock-wise mean, i.e, mean angle in ]other, this].

if this == other, it is by definition this.

Parameters:

[in]

other

The other angle.

Returns:

Mean angle in ]other, this].

string Ang2Pim::print

(

void

)

Print function.

Returns:

A printable string with the value printed on it.

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

---

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

• baselib/Spaces/S1m.h
• baselib/Spaces/S1m.cpp