Public Member Functions
constexpr	Angle (long double n=0.0)
	Constructor with a value in radian in [-pi,pi].

constexpr	Angle (const Angle &ang)
	Copy constructor from another Angle.

constexpr long double	get_value () const
	Getter of the value attribute.

constexpr Angle &	operator= (long double n)
	Overload the = operator.

constexpr Angle &	operator- ()
	Overload the - operator.

constexpr Angle &	operator+= (const Angle &rhs)
	Overload the += operator.

constexpr Angle	operator+ (const Angle &rhs) const
	Overload the + operator.

constexpr Angle &	operator-= (const Angle &rhs)
	Overload the -= operator.

constexpr Angle	operator- (const Angle &rhs) const
	Overload the - operator.

constexpr Angle &	operator*= (double lambda)
	Overload the *= operator with a scalar.

constexpr Angle	operator* (double lambda) const
	Overload the * operator with a scalar.

constexpr Angle &	operator/= (double lambda)
	Overload the /= operator with a scalar.

constexpr Angle	operator/ (double lambda) const
	Overload the / operator with a scalar.

constexpr bool	operator== (const Angle &rhs) const
	Overload the == operator.

constexpr bool	operator!= (const Angle &rhs) const
	Overload the != operator.

constexpr bool	operator> (const Angle &rhs) const
	Overload the > operator.

constexpr bool	operator>= (const Angle &rhs) const
	Overload the > operator.

constexpr bool	operator< (const Angle &rhs) const
	Overload the < operator.

constexpr bool	operator<= (const Angle &rhs) const
	Overload the < operator.

Friends
constexpr double	operator/ (const Angle &lhs, const Angle &rhs)
	Overload the / operator between two Angles.

constexpr Angle	operator* (double lambda, const Angle &rhs)
	Overload the / operator with a scalar on the left side.

constexpr Angle	literals::operator""_rad (long double n)
	Literal operator to create an Angle in radian.

constexpr Angle	literals::operator""_deg (long double n)
	Literal operator to create an Angle in degrees.

Detailed Description

Definition at line 24 of file Angle.hpp.

Constructor & Destructor Documentation

◆ Angle() [1/2]

constexpr state_representation::units::Angle::Angle ( long double n = 0.0 )

constexpr

Constructor with a value in radian in [-pi,pi].

Parameters

n	the value in radian

Definition at line 188 of file Angle.hpp.

◆ Angle() [2/2]

constexpr state_representation::units::Angle::Angle ( const Angle & ang )

constexpr

Copy constructor from another Angle.

Parameters

ang	the Angle to copy

Definition at line 191 of file Angle.hpp.

Member Function Documentation

◆ get_value()

constexpr long double state_representation::units::Angle::get_value ( ) const

constexpr

Getter of the value attribute.

Returns: the value in radian

Definition at line 194 of file Angle.hpp.

◆ operator!=()

constexpr bool state_representation::units::Angle::operator!= ( const Angle & rhs ) const

constexpr

Overload the != operator.

Parameters

rhs	the other Angle to check inequality with

Returns: bool true if the two Angles are different

Definition at line 260 of file Angle.hpp.

◆ operator*()

constexpr Angle state_representation::units::Angle::operator* ( double lambda ) const

constexpr

Overload the * operator with a scalar.

Parameters

lambda the scalar to multiply with

Returns: the Angle multiply by lambda

Definition at line 238 of file Angle.hpp.

◆ operator*=()

constexpr Angle & state_representation::units::Angle::operator*= ( double lambda )

constexpr

Overload the *= operator with a scalar.

Parameters

lambda the scalar to multiply with

Returns: the Angle multiply by lambda

Definition at line 232 of file Angle.hpp.

◆ operator+()

constexpr Angle state_representation::units::Angle::operator+ ( const Angle & rhs ) const

constexpr

Overload the + operator.

Parameters

rhs	Angle to add

Returns: the current Angle added the Angle given in argument

Definition at line 214 of file Angle.hpp.

◆ operator+=()

constexpr Angle & state_representation::units::Angle::operator+= ( const Angle & rhs )

constexpr

Overload the += operator.

Parameters

rhs	Angle to add

Returns: the current Angle added the Angle given in argument

Definition at line 208 of file Angle.hpp.

◆ operator-() [1/2]

constexpr Angle & state_representation::units::Angle::operator- ( )

constexpr

Overload the - operator.

Returns: the negative angle in radian

Definition at line 203 of file Angle.hpp.

◆ operator-() [2/2]

constexpr Angle state_representation::units::Angle::operator- ( const Angle & rhs ) const

constexpr

Overload the - operator.

Parameters

rhs	Angle to subtract

Returns: the current Angle minus the Angle given in argument

Definition at line 226 of file Angle.hpp.

◆ operator-=()

constexpr Angle & state_representation::units::Angle::operator-= ( const Angle & rhs )

constexpr

Overload the -= operator.

Parameters

rhs	Angle to subtract

Returns: the current Angle minus the Angle given in argument

Definition at line 220 of file Angle.hpp.

◆ operator/()

constexpr Angle state_representation::units::Angle::operator/ ( double lambda ) const

constexpr

Overload the / operator with a scalar.

Parameters

lambda the scalar to divide by

Returns: the Angle divided by lambda

Definition at line 250 of file Angle.hpp.

◆ operator/=()

constexpr Angle & state_representation::units::Angle::operator/= ( double lambda )

constexpr

Overload the /= operator with a scalar.

Parameters

lambda the scalar to divide by

Returns: the Angle divided by lambda

Definition at line 244 of file Angle.hpp.

◆ operator<()

constexpr bool state_representation::units::Angle::operator< ( const Angle & rhs ) const

constexpr

Overload the < operator.

Parameters

rhs	the other Angle to check strict inferiority with

Returns: bool true if the current Angle is strictly inferior than provided Angle

Definition at line 272 of file Angle.hpp.

◆ operator<=()

constexpr bool state_representation::units::Angle::operator<= ( const Angle & rhs ) const

constexpr

Overload the < operator.

Parameters

rhs	the other Angle to check inferiority with

Returns: bool true if the current Angle is inferior than provided Angle

Definition at line 276 of file Angle.hpp.

◆ operator=()

constexpr Angle & state_representation::units::Angle::operator= ( long double n )

constexpr

Overload the = operator.

Parameters

n	the angle value to assign in radian

Returns: the angle in radian

Definition at line 198 of file Angle.hpp.

◆ operator==()

constexpr bool state_representation::units::Angle::operator== ( const Angle & rhs ) const

constexpr

Overload the == operator.

Parameters

rhs	the other Angle to check equality with

Returns: bool true if the two Angles are equal

Definition at line 256 of file Angle.hpp.

◆ operator>()

constexpr bool state_representation::units::Angle::operator> ( const Angle & rhs ) const

constexpr

Overload the > operator.

Parameters

rhs	the other Angle to check strict superiority with

Returns: bool true if the current Angle is strictly superior than provided Angle

Definition at line 264 of file Angle.hpp.

◆ operator>=()

constexpr bool state_representation::units::Angle::operator>= ( const Angle & rhs ) const

constexpr

Overload the > operator.

Parameters

rhs	the other Angle to check superiority with

Returns: bool true if the current Angle is superior than provided Angle

Definition at line 268 of file Angle.hpp.

Friends And Related Symbol Documentation

◆ literals::operator""_deg

constexpr Angle literals::operator""_deg ( long double n )

friend

Literal operator to create an Angle in degrees.

Parameters

n	the angle value in degree
the	Angle in the base unit (radian)

◆ literals::operator""_rad

constexpr Angle literals::operator""_rad ( long double n )

friend

Literal operator to create an Angle in radian.

Parameters

n	the angle value in radian
the	Angle in the base unit (radian)

◆ operator*

constexpr Angle operator*	(	double	lambda,
		const Angle &	rhs
	)

friend

Overload the / operator with a scalar on the left side.

Parameters

lambda the scalar to multiply with

Returns: the Angle multiply by lambda

Definition at line 284 of file Angle.hpp.

◆ operator/

constexpr double operator/	(	const Angle &	lhs,
		const Angle &	rhs
	)

friend

Overload the / operator between two Angles.

Parameters

lhs	the first Angle
rhs	the second Angle

Returns: the ratio between first and second Angle

Definition at line 280 of file Angle.hpp.

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

/github/workspace/source/state_representation/include/state_representation/units/Angle.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Angle() [1/2]

◆ Angle() [2/2]

Member Function Documentation

◆ get_value()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

Friends And Related Symbol Documentation

◆ literals::operator""_deg

◆ literals::operator""_rad

◆ operator*

◆ operator/