A class to represent and manipulate cyclic values (e.g., angles). More...

#include <comp_type.hpp>

Public Member Functions
CycleValue &	operator= (const CycleValue &)=default
	Default copy assignment operator.

	CycleValue (const float &value)
	Constructs a CycleValue object from a float.

	CycleValue (const double &value)
	Constructs a CycleValue object from a double.

	CycleValue (const CycleValue &value)
	Copy constructor. Ensures the copied value remains within [0, 2π).

	CycleValue ()
	Default constructor. Initializes the value to 0.

CycleValue	operator+ (const float &value)
	Adds a float value and returns the resulting CycleValue.

CycleValue	operator+ (const double &value)
	Adds a double value and returns the resulting CycleValue.

CycleValue	operator+ (const CycleValue &value)
	Adds another CycleValue and returns the result.

CycleValue	operator+= (const float &value)
	In-place addition of a float value.

CycleValue	operator+= (const double &value)
	In-place addition of a double value.

CycleValue	operator+= (const CycleValue &value)
	In-place addition of another CycleValue.

float	operator- (const float &raw_value)
	Computes the difference between this value and a float value.

float	operator- (const double &raw_value)
	Computes the difference between this value and a double value.

float	operator- (const CycleValue &value)
	Computes the difference between this value and another CycleValue.

CycleValue	operator- ()
	Negates the current value.

	operator float ()
	Implicit conversion to float.

CycleValue &	operator= (const float &value)
	Assigns a float value.

CycleValue &	operator= (const double &value)
	Assigns a double value.

float	Value ()
	Returns the current value.

Static Public Member Functions
static float	Calculate (float value)
	Normalizes a value to the range [0, 2π).

Private Attributes
float	value_

Detailed Description

A class to represent and manipulate cyclic values (e.g., angles).

This class ensures that values remain within a cyclic range, such as [0, 2π), and provides arithmetic operations while preserving this property.

Definition at line 13 of file comp_type.hpp.

Constructor & Destructor Documentation

◆ CycleValue() [1/4]

Type::CycleValue::CycleValue ( const float & value )

inline

Constructs a CycleValue object from a float.

Parameters

value The input value.

Definition at line 39 of file comp_type.hpp.

39: value_(Calculate(value)) {}

Type::CycleValue::Calculate

static float Calculate(float value)

Normalizes a value to the range [0, 2π).

Definition comp_type.hpp:26

◆ CycleValue() [2/4]

Type::CycleValue::CycleValue ( const double & value )

inline

Constructs a CycleValue object from a double.

Parameters

value The input value.

Definition at line 46 of file comp_type.hpp.

47 : value_(Calculate(static_cast<float>(value))) {}

◆ CycleValue() [3/4]

Type::CycleValue::CycleValue ( const CycleValue & value )

inline

Copy constructor. Ensures the copied value remains within [0, 2π).

Parameters

value Another CycleValue object.

Definition at line 54 of file comp_type.hpp.

                                      : value_(value.value_) {
    while (value_ >= M_2PI) {
      value_ -= M_2PI;
    }
 
    while (value_ < 0) {
      value_ += M_2PI;
    }
  }

◆ CycleValue() [4/4]

Type::CycleValue::CycleValue ( )

inline

Default constructor. Initializes the value to 0.

Definition at line 67 of file comp_type.hpp.

67: value_(0.0f) {}

Member Function Documentation

◆ Calculate()

static float Type::CycleValue::Calculate ( float value )

inlinestatic

Normalizes a value to the range [0, 2π).

Parameters

value The input value (in radians).

Returns: The normalized value within [0, 2π).

Definition at line 26 of file comp_type.hpp.

                                      {
    value = std::fmodf(value, M_2PI);
    if (value < 0) {
      value += M_2PI;
    }
    return value;
  }

◆ operator float()

Type::CycleValue::operator float ( )

inline

Implicit conversion to float.

Returns: The normalized value as a float.

Definition at line 203 of file comp_type.hpp.

203{ return this->value_; }

◆ operator+() [1/3]

CycleValue Type::CycleValue::operator+ ( const CycleValue & value )

inline

Adds another CycleValue and returns the result.

Parameters

value Another CycleValue object.

Returns: A new CycleValue object.

Definition at line 95 of file comp_type.hpp.

                                                {
    return CycleValue(value.value_ + value_);
  }

◆ operator+() [2/3]

CycleValue Type::CycleValue::operator+ ( const double & value )

inline

Adds a double value and returns the resulting CycleValue.

Parameters

value The value to add.

Returns: A new CycleValue object.

Definition at line 85 of file comp_type.hpp.

                                            {
    return CycleValue(static_cast<float>(value) + value_);
  }

◆ operator+() [3/3]

CycleValue Type::CycleValue::operator+ ( const float & value )

inline

Adds a float value and returns the resulting CycleValue.

Parameters

value The value to add.

Returns: A new CycleValue object.

Definition at line 75 of file comp_type.hpp.

                                           {
    return CycleValue(value + value_);
  }

◆ operator+=() [1/3]

CycleValue Type::CycleValue::operator+= ( const CycleValue & value )

inline

In-place addition of another CycleValue.

Parameters

value Another CycleValue object.

Returns: A reference to this object.

Definition at line 127 of file comp_type.hpp.

                                                 {
    value_ = Calculate(value.value_ + value_);
    return *this;
  }

◆ operator+=() [2/3]

CycleValue Type::CycleValue::operator+= ( const double & value )

inline

In-place addition of a double value.

Parameters

value The value to add.

Returns: A reference to this object.

Definition at line 116 of file comp_type.hpp.

                                             {
    value_ = Calculate(static_cast<float>(value) + value_);
    return *this;
  }

◆ operator+=() [3/3]

CycleValue Type::CycleValue::operator+= ( const float & value )

inline

In-place addition of a float value.

Parameters

value The value to add.

Returns: A reference to this object.

Definition at line 105 of file comp_type.hpp.

                                            {
    value_ = Calculate(value + value_);
    return *this;
  }

◆ operator-() [1/4]

CycleValue Type::CycleValue::operator- ( )

inline

Negates the current value.

Returns: A new CycleValue object.

Definition at line 196 of file comp_type.hpp.

196{ return CycleValue(M_2PI - value_); }

◆ operator-() [2/4]

float Type::CycleValue::operator- ( const CycleValue & value )

inline

Computes the difference between this value and another CycleValue.

Parameters

value Another CycleValue object.

Returns: The difference normalized to [-π, π).

Definition at line 178 of file comp_type.hpp.

                                           {
    float ans = value_ - value.value_;
    while (ans >= M_PI) {
      ans -= M_2PI;
    }
 
    while (ans < -M_PI) {
      ans += M_2PI;
    }
 
    return ans;
  }

◆ operator-() [3/4]

float Type::CycleValue::operator- ( const double & raw_value )

inline

Computes the difference between this value and a double value.

Parameters

raw_value The value to subtract.

Returns: The difference normalized to [-π, π).

Definition at line 158 of file comp_type.hpp.

                                           {
    float value = Calculate(static_cast<float>(raw_value));
    float ans = value_ - value;
    while (ans >= M_PI) {
      ans -= M_2PI;
    }
 
    while (ans < -M_PI) {
      ans += M_2PI;
    }
 
    return ans;
  }

◆ operator-() [4/4]

float Type::CycleValue::operator- ( const float & raw_value )

inline

Computes the difference between this value and a float value.

Parameters

raw_value The value to subtract.

Returns: The difference normalized to [-π, π).

Definition at line 138 of file comp_type.hpp.

                                          {
    float value = Calculate(raw_value);
    float ans = value_ - value;
    while (ans >= M_PI) {
      ans -= M_2PI;
    }
 
    while (ans < -M_PI) {
      ans += M_2PI;
    }
 
    return ans;
  }

◆ operator=() [1/2]

CycleValue & Type::CycleValue::operator= ( const double & value )

inline

Assigns a double value.

Parameters

value The value to assign.

Returns: A reference to this object.

Definition at line 222 of file comp_type.hpp.

                                             {
    value_ = Calculate(static_cast<float>(value));
    return *this;
  }

◆ operator=() [2/2]

CycleValue & Type::CycleValue::operator= ( const float & value )

inline

Assigns a float value.

Parameters

value The value to assign.

Returns: A reference to this object.

Definition at line 211 of file comp_type.hpp.

                                            {
    value_ = Calculate(value);
    return *this;
  }

◆ Value()

float Type::CycleValue::Value ( )

inline

Returns the current value.

Returns: The value as a float.

Definition at line 232 of file comp_type.hpp.

232{ return value_; }

Field Documentation

◆ value_

float Type::CycleValue::value_

private

Definition at line 235 of file comp_type.hpp.

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

src/component/comp_type.hpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CycleValue() [1/4]

◆ CycleValue() [2/4]

◆ CycleValue() [3/4]

◆ CycleValue() [4/4]

Member Function Documentation

◆ Calculate()

◆ operator float()

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-() [1/4]

◆ operator-() [2/4]

◆ operator-() [3/4]

◆ operator-() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Value()

Field Documentation

◆ value_