mrs_lib::geometry::sradians Struct Reference

Convenience specialization of the cyclic class for signed radians (from $-\pi$ to $\pi$). More...

#include <cyclic.h>

Inheritance diagram for mrs_lib::geometry::sradians:

Collaboration diagram for mrs_lib::geometry::sradians:

Static Public Attributes
static constexpr double	minimum = -M_PI
static constexpr double	supremum = M_PI
Static Public Attributes inherited from mrs_lib::geometry::cyclic< double, sradians >
static constexpr double	minimum
	Minimum of the valid interval of wrapped values .
static constexpr double	supremum
	Supremum of the valid interval of wrapped values .
static constexpr double	range
	Range of the valid interval of wrapped values (also the period of the cyclic quantity).
static constexpr double	half_range
	Half of the range of the valid interval of wrapped values (used for some calculations).

Additional Inherited Members
Public Member Functions inherited from mrs_lib::geometry::cyclic< double, sradians >
	cyclic ()
	Default constructor.
	cyclic (const double val)
	Constructor overload.
	cyclic (const cyclic &other)
	Copy constructor.
	cyclic (const sradians &other)
	Copy constructor.
double	value () const
	Getter for val.
other_t	convert () const
	Conversion between two different circular quantities.
cyclic &	operator= (const double nval)
	Assignment operator.
cyclic &	operator= (const cyclic &other)
	Assignment operator.
cyclic &	operator= (cyclic &&other)
	Move operator.
cyclic &	operator+= (const cyclic &other)
	Addition compound operator.
cyclic &	operator-= (const cyclic &other)
	Subtraction compound operator.
Static Public Member Functions inherited from mrs_lib::geometry::cyclic< double, sradians >
static bool	inRange (const double val)
	Checks if val is within the valid interval of wrapped values.
static double	wrap (const double val)
	Returns val, converted to the valid interval of values.
static double	unwrap (const double what, const double from)
	Returns value of the parameter what modified so that there is no "jump" between from and \t what.
static double	pdist (const double from, const double to)
	Returns length of the shortest walk in the positive direction from the first parameter to the second one.
static double	pdist (const cyclic from, const cyclic to)
static double	diff (const double minuend, const double subtrahend)
	Returns the difference between the two circular values.
static double	diff (const cyclic minuend, const cyclic subtrahend)
static double	dist (const double from, const double to)
	Returns the distance between the two circular values.
static double	dist (const cyclic from, const cyclic to)
static double	interpUnwrapped (const double from, const double to, const double coeff)
	Interpolation between two circular quantities without wrapping of the result.
static double	interpUnwrapped (const cyclic from, const cyclic to, const double coeff)
static double	interp (const double from, const double to, const double coeff)
	Interpolation between two circular quantities.
static double	interp (const cyclic from, const cyclic to, const double coeff)
static double	pinterpUnwrapped (const double from, const double to, const double coeff)
	Interpolation between two circular quantities in the positive direction without wrapping of the result.
static double	pinterpUnwrapped (const cyclic from, const cyclic to, const double coeff)
static double	pinterp (const double from, const double to, const double coeff)
	Interpolation between two circular quantities in the positive direction.
static double	pinterp (const cyclic from, const cyclic to, const double coeff)
static other_t	convert (const cyclic &what)
	Conversion between two different circular quantities.
Protected Attributes inherited from mrs_lib::geometry::cyclic< double, sradians >
double	val

Detailed Description

Convenience specialization of the cyclic class for signed radians (from $-\pi$ to $\pi$).

Examples

geometry/cyclic_example.cpp.

---

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

• include/mrs_lib/geometry/cyclic.h