Anglem Class Reference
[Spaces]

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

#include <S1m.h>

List of all members.

Public Member Functions
	Anglem ()
	Default constructor.
	Anglem (UCoordmm t)
	UCoordmm constructor.
	Anglem (const Anglem &rhs)
	Copy constructor.
Anglem &	operator= (const Anglem &rhs)
	Assigment operator =.
Anglem &	operator+= (const Anglem &a)
	Compound assignment operator +=.
Anglem &	operator-= (const Anglem &a)
	Compound assignment operator -=.
Anglem &	operator*= (const Coordmm &d)
	Compound assignment operator *= with scalar.
Anglem &	operator*= (const UCoordmm &d)
	Compound assignment operator *= with scalar.
Anglem &	operator*= (const int &d)
	Compound assignment operator *= with scalar.
const Anglem	operator+ (const Anglem &other) const
	Binary arithmetic operator +.
const Anglem	operator- (const Anglem &other) const
	Binary arithmetic operator -.
const Anglem	operator* (const Coordmm &d) const
	Binary arithmetic operator * with scalar.
const Anglem	operator* (const UCoordmm &d) const
	Binary arithmetic operator * with scalar.
const Anglem	operator* (const int &d) const
	Binary arithmetic operator * with scalar.
bool	operator== (const Anglem &other) const
	Compound operator ==.
bool	operator!= (const Anglem &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 Anglem &other)
	Algebric difference (in ]-PI,PI]).
Coordmm	ccwDiff (const Anglem &other)
	Counter-clock-wise difference (in [0,2*PI[).
Coordmm	cwDiff (const Anglem &other)
	Clock-wise difference (in ]-2*PI,0]).
bool	almostEqual (Anglem A, Coordmm toll)
	Equal condition with a tollerance.
Anglem	mean (const Anglem &other)
	The same as ccwMean.
Anglem	ccwMean (const Anglem &other)
	Counter-clock-wise mean, i.e, mean angle in ]this, other].
Anglem	cwMean (const Anglem &other)
	Clock-wise mean, i.e, mean angle in ]other, this].
string	print ()
	Print function.

---

Detailed Description

Represents angles in [0,2*MPIm).

Author:

Paolo Stegagno

Todo:

make this a derived class of S1

---

Constructor & Destructor Documentation

Anglem::Anglem

(

)

[inline]

Default constructor.

Anglem::Anglem

(

UCoordmm

t

)

[inline]

UCoordmm constructor.

Anglem::Anglem

(

const Anglem &

rhs

)

[inline]

Copy constructor.

---

Member Function Documentation

Anglem& Anglem::operator=

(

const Anglem &

rhs

)

[inline]

Assigment operator =.

Anglem& Anglem::operator+=

(

const Anglem &

a

)

[inline]

Compound assignment operator +=.

Anglem& Anglem::operator-=

(

const Anglem &

a

)

[inline]

Compound assignment operator -=.

Anglem& Anglem::operator*=

(

const Coordmm &

d

)

[inline]

Compound assignment operator *= with scalar.

compound assignment operator *=

Anglem& Anglem::operator*=

(

const UCoordmm &

d

)

[inline]

Compound assignment operator *= with scalar.

Anglem& Anglem::operator*=

(

const int &

d

)

[inline]

Compound assignment operator *= with scalar.

const Anglem Anglem::operator+

(

const Anglem &

other

)

const [inline]

Binary arithmetic operator +.

const Anglem Anglem::operator-

(

const Anglem &

other

)

const [inline]

Binary arithmetic operator -.

const Anglem Anglem::operator*

(

const Coordmm &

d

)

const [inline]

Binary arithmetic operator * with scalar.

binary arithmetic operator *

const Anglem Anglem::operator*

(

const UCoordmm &

d

)

const [inline]

Binary arithmetic operator * with scalar.

const Anglem Anglem::operator*

(

const int &

d

)

const [inline]

Binary arithmetic operator * with scalar.

bool Anglem::operator==

(

const Anglem &

other

)

const [inline]

Compound operator ==.

bool Anglem::operator!=

(

const Anglem &

other

)

const [inline]

Compound operator !=.

UCoordmm Anglem::dCast

(

)

const [inline]

Explicit casting to UCoordmm.

Coordmm Anglem::dCastPi

(

)

[inline]

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

Coordmm Anglem::dCastDeg

(

)

[inline]

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

Decimal Anglem::dCastPiDecimal

(

)

[inline]

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

Coordmm Anglem::alDiff

(

const Anglem &

other

)

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

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

Parameters:

[in]

other

the Anglem respect to it is computed the algebric distance

Returns:

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

Coordmm Anglem::ccwDiff

(

const Anglem &

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 Anglem::cwDiff

(

const Anglem &

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 Anglem::almostEqual	(	Anglem	A,
		Coordmm	toll
	)

Equal condition with a tollerance.

Parameters:

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

Returns:

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

Anglem Anglem::mean

(

const Anglem &

other

)

The same as ccwMean.

Parameters:

[in]

other

the Anglem respect to it is computed the mean.

Returns:

An angle that is.

Anglem Anglem::ccwMean

(

const Anglem &

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].

Anglem Anglem::cwMean

(

const Anglem &

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 Anglem::print

(

)

Print function.

Returns:

A printable string with the value printed on it.

---

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

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