jrlMathTools::Angle Class Reference

This class implements simple computations on angles. More...

#include <jrl/mathtools/angle.hh>

Public Member Functions
	Angle ()
	Angle (const double &angle)
	Angle (const Angle &angle)
	Copy Constructor. More...
	~Angle ()
	Trivial destructor. More...
const double &	value () const
	Angle value. More...
double	degree () const
	Return value in degrees (for output only!). More...
	operator const double & () const
	Cast into a double. More...
Angle &	operator= (const Angle &angle)
	Operator =. More...
Angle &	operator= (const double &value)
	Operator = with a double. More...
Angle	interpolate (const double &alpha, const Angle &angle) const
	Interpolation between two angles. More...
std::ostream &	display (std::ostream &os) const
	output to a stream. More...
double	distance (const Angle &angle) const
	Distance on unit circle. More...
Angle	operator+ (const Angle &angle) const
	Arithmetic operators overload. More...
Angle	operator- (const Angle &angle) const
Angle &	operator+= (const Angle &rhs)
Angle &	operator-= (const Angle &rhs)
template<typename T >
Angle	operator+ (const T &angle) const
template<typename T >
Angle	operator- (const T &angle) const
template<typename T >
Angle &	operator+= (const T &rhs)
template<typename T >
Angle &	operator-= (const T &rhs)
template<typename T >
Angle	operator* (const T &rhs) const
template<typename T >
Angle	operator*= (const T &rhs) const
template<typename T >
Angle	operator/= (const T &rhs) const

Static Public Member Functions
static Angle	radian (const double &value)
	Named constructors. More...
static Angle	degree (const double &value)

Protected Member Functions
void	setBetweenMinusAndPlusPI ()
	Set angle between -PI and PI. More...
void	set (const double &value)
	Update angle value. More...

Protected Attributes
double	angle_
	angular value. More...

Detailed Description

This class implements simple computations on angles.

All angles MUST be expressed in radian.

Facilities are provided for degree/radian conversion for display/debugging only.

Constructor & Destructor Documentation

jrlMathTools::Angle::Angle ( )

inline

Referenced by degree(), interpolate(), operator*(), operator+(), operator-(), and radian().

jrlMathTools::Angle::Angle ( const double &  angle )

inline

References set().

jrlMathTools::Angle::Angle ( const Angle &  angle )

inline

Copy Constructor.

jrlMathTools::Angle::~Angle ( )

inline

Trivial destructor.

Member Function Documentation

static Angle jrlMathTools::Angle::degree ( const double &  value )

inlinestatic

References Angle(), and jrlMathTools::degreeToRadian().

double jrlMathTools::Angle::degree ( ) const

inline

Return value in degrees (for output only!).

References jrlMathTools::radianToDegree(), and value().

std::ostream& jrlMathTools::Angle::display ( std::ostream &  os ) const

inline

output to a stream.

References angle_.

Referenced by jrlMathTools::display().

double jrlMathTools::Angle::distance ( const Angle &  angle ) const

inline

Distance on unit circle.

References value().

Angle jrlMathTools::Angle::interpolate ( const double &  alpha, const Angle &  angle  ) const

inline

Interpolation between two angles.

Parameters

alpha	interpolation parameter between 0 and 1.
angle	second angle of interpolation.

Returns

an angle between this one and angle along the shortest arc.

• if alpha = 0, return this angle,
• if alpha = 1, return angle.

References Angle(), and value().

jrlMathTools::Angle::operator const double & ( ) const

inline

Cast into a double.

References value().

template<typename T >

Angle jrlMathTools::Angle::operator* ( const T &  rhs ) const

inline

References Angle(), and angle_.

template<typename T >

Angle jrlMathTools::Angle::operator*= ( const T &  rhs ) const

inline

References set(), and value().

Angle jrlMathTools::Angle::operator+ ( const Angle &  angle ) const

inline

Arithmetic operators overload.

References Angle(), and value().

template<typename T >

Angle jrlMathTools::Angle::operator+ ( const T &  angle ) const

inline

References Angle(), and value().

Angle& jrlMathTools::Angle::operator+= ( const Angle &  rhs )

inline

References set(), and value().

template<typename T >

Angle& jrlMathTools::Angle::operator+= ( const T &  rhs )

inline

References set(), and value().

Angle jrlMathTools::Angle::operator- ( const Angle &  angle ) const

inline

References Angle(), and value().

template<typename T >

Angle jrlMathTools::Angle::operator- ( const T &  angle ) const

inline

References Angle(), and value().

Angle& jrlMathTools::Angle::operator-= ( const Angle &  rhs )

inline

References set(), and value().

template<typename T >

Angle& jrlMathTools::Angle::operator-= ( const T &  rhs )

inline

References set(), and value().

template<typename T >

Angle jrlMathTools::Angle::operator/= ( const T &  rhs ) const

inline

References set(), and value().

Angle& jrlMathTools::Angle::operator= ( const Angle &  angle )

inline

Operator =.

References set(), and value().

Angle& jrlMathTools::Angle::operator= ( const double &  value )

inline

Operator = with a double.

References set().

static Angle jrlMathTools::Angle::radian ( const double &  value )

inlinestatic

Named constructors.

References Angle().

void jrlMathTools::Angle::set ( const double &  value )

inlineprotected

Update angle value.

References angle_, setBetweenMinusAndPlusPI(), and value().

Referenced by Angle(), operator*=(), operator+=(), operator-=(), operator/=(), and operator=().

void jrlMathTools::Angle::setBetweenMinusAndPlusPI ( )

inlineprotected

Set angle between -PI and PI.

References angle_, and M_PI.

Referenced by set().

const double& jrlMathTools::Angle::value ( ) const

inline

Angle value.

References angle_.

Referenced by jrlMathTools::cos(), degree(), distance(), interpolate(), operator const double &(), jrlMathTools::operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/=(), operator=(), set(), jrlMathTools::sin(), and jrlMathTools::tan().

Member Data Documentation

double jrlMathTools::Angle::angle_

protected

angular value.

Referenced by display(), operator*(), set(), setBetweenMinusAndPlusPI(), and value().