scifir::angle Class Reference

Class that allows to work with angles. Each angle sizes 4 bytes. Initialization string example: "20°". More...

#include <angle.hpp>

Inheritance diagram for scifir::angle:

Public Types
enum	type : int8_t { DEGREE , RADIAN , GRADIAN , TURN }
	Represents an type of angle, which can be a degree or a radian. The value of the angle inside the angle class is always stored in degrees, but can be get in radian if it's needed. More...

Public Member Functions
	angle ()
	Default constructor of angle. The value is set to 0.
	angle (const angle &x)
	Copy constructor of angle. The value is copied from the angle x.
	angle (angle &&x)
	Move constructor of angle. The value is moved from the angle x.
	angle (float new_value, angle::type init_type=angle::DEGREE)
	Constructor of angle. The value is initialized to the float new_value. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.
	angle (double new_value, angle::type init_type=angle::DEGREE)
	Constructor of angle. The value is initialized from the double new_value casted to a float. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.
	angle (long double new_value, angle::type init_type=angle::DEGREE)
	Constructor of angle. The value is initialized from the long double new_value casted to a float. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.
	angle (int new_value, angle::type init_type=angle::DEGREE)
	Constructor of angle. The value is initialized from the int new_value casted to a float. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.
	angle (const string &init_angle)
	Constructor of angle. The value is initialized from the initialization string of angle, which uses the character 00B0 or the character 00BA to represent degrees.
	angle (const scalar_unit &x)
	Constructor of angle. The value is initialized from the scalar_unit x, if the scalar_unit has empty dimensions.
angle &	operator= (const angle &x)
	Copy assignment of angle. The value is copied to the value of angle x.
angle &	operator= (angle &&x)
	Move assignment of angle. The value is moved from the value of angle x.
angle &	operator= (float new_value)
	Assignment operator. The value is copied from the float.
angle &	operator= (const string &init_angle)
	Assignment operator. An initialization string is used to set the value, which contains the character 00B0 or the character 00BA to represent degrees.
angle &	operator= (const scalar_unit &x)
	Assignment operator. The value of the angle is set to the value of the scalar_unit x, only if the scalar_unit has empty dimensions.
	operator float () const
	Cast angle to a float.
const float &	get_value () const
	Gets the value of the angle, in degrees.
angle	operator+ (const angle &x) const
	Creates a new angle as the sum of other two.
angle	operator- (const angle &x) const
	Creates a new angle as the substraction of this angle and another angle x.
angle	operator* (const angle &x) const
	Creates a new angle as the multiplication of other two.
angle	operator/ (const angle &x) const
	Creates a new angle as the division of this angle and another angle x.
angle	operator^ (const angle &x) const
	Creates a new angle by powering the angle class with the value of another angle x.
void	operator+= (const angle &x)
	Sums the value of the angle x to the value of this angle. The value is normalized after.
void	operator-= (const angle &x)
	Substract the value of the angle x to the value of this angle. The value is normalized after.
void	operator*= (const angle &x)
	Multiplies the value of this angle with the value of angle x. The value is normalized after.
void	operator/= (const angle &x)
	Divides the value of this angle with the value of angle x. The value is normalized after.
void	operator^= (const angle &x)
	Powers the value of this angle with the value of angle x. The value is normalized after.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator= (T new_value)
	Sets the value to the value of some numeric type, casting it to a float first, and normalizing the value after that.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
angle	operator+ (T x) const
	Creates a new angle as the sum of a numeric type with the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
angle	operator- (T x) const
	Creates a new angle as the substraction of the value of this angle with a numeric type.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
angle	operator* (T x) const
	Creates a new angle as the multiplication of a numeric type with the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
angle	operator/ (T x) const
	Creates a new angle as the division of a numeric type with the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
angle	operator^ (T x) const
	Creates a new angle as the power of the value of this angle with a numeric type.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator+= (T x)
	Sums a numeric type to the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator-= (T x)
	Substracts a numeric type to the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator*= (T x)
	Multiplies a numeric type to the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator/= (T x)
	Divides a numeric type to the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator^= (T x)
	Powers a numeric type to the value of this angle.
angle &	operator++ ()
	Increments the value by one.
angle	operator++ (int)
	Increments the value by one.
angle &	operator-- ()
	Decrements the value by one.
angle	operator-- (int)
	Decrements the value by one.
void	invert ()
	Inverts the angle to the opposite direction in a 2D plane, which is to add 180 degrees. The value is normalized after.
scalar_unit	to_scalar_unit () const
	Creates a scalar_unit with the same value and degree dimensions.
string	display (int number_of_decimals=2) const
	Creates an string from the angle, with the value and the degrees symbol.
float	get_degree () const
	Gets the value of the angle in degrees.
float	get_radian () const
	Gets the value of the angle in radians.

Protected Member Functions
void	initialize_from_string (string init_angle)
	Internal function. Sets the value of the angle to a new value using the initialization string of angles.

Protected Attributes
float	value
	Value of the angle. It is stored in degrees.

Private Member Functions
void	normalize_value ()
	Internal function. Normalizes the value, which means to maintain the same angle within 0 and 360. If the value is lower or greather it gets converted to their equivalent counterpart within this range.

Detailed Description

Class that allows to work with angles. Each angle sizes 4 bytes. Initialization string example: "20°".

angle is a class that allows to work with angles, more in degrees than in radians. The value of the angle is always stored inside the class in degrees, and it can be get in radians with the to_radian() function.

Definition at line 76 of file angle.hpp.

Member Enumeration Documentation

type

enum scifir::angle::type : int8_t

Represents an type of angle, which can be a degree or a radian. The value of the angle inside the angle class is always stored in degrees, but can be get in radian if it's needed.

Enumerator
DEGREE	The angle is in DEGREE. A degree is defined as a 1/360 part of a circle. The entire circle corresponds to 360 degrees.
RADIAN	The angle is in RADIAN. A radian is defined as the length of the perimeter of the circle that conforms an angle.
GRADIAN
TURN

Definition at line 79 of file angle.hpp.

: int8_t {DEGREE,RADIAN,GRADIAN,TURN};

Constructor & Destructor Documentation

angle() [1/9]

angle::angle

(

)

Default constructor of angle. The value is set to 0.

Definition at line 18 of file angle.cpp.

                 : value(0.0f)
    {}

angle() [2/9]

angle::angle

(

const angle &

x

)

Copy constructor of angle. The value is copied from the angle x.

Definition at line 21 of file angle.cpp.

                               : value(x.get_value())
    {}

angle() [3/9]

angle::angle

(

angle &&

x

)

Move constructor of angle. The value is moved from the angle x.

Definition at line 24 of file angle.cpp.

                          : value(std::move(x.get_value()))
    {}

angle() [4/9]

angle::angle ( float  new_value, angle::type  init_type = angle::DEGREE  )

explicit

Constructor of angle. The value is initialized to the float new_value. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.

Definition at line 27 of file angle.cpp.

                                                    : value()
    {
        if (init_type == angle::DEGREE)
        {
            value = new_value;
        }
        else if (init_type == angle::RADIAN)
        {
            value = radian_to_degree(new_value);
        }
        else if (init_type == angle::GRADIAN)
        {
            value = gradian_to_degree(new_value);
        }
        else if (init_type == angle::TURN)
        {
            value = turn_to_degree(new_value);
        }
        normalize_value();
    }

angle() [5/9]

angle::angle ( double  new_value, angle::type  init_type = angle::DEGREE  )

explicit

Constructor of angle. The value is initialized from the double new_value casted to a float. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.

Definition at line 48 of file angle.cpp.

                                                     : value()
    {
        if (init_type == angle::DEGREE)
        {
            value = float(new_value);
        }
        else if (init_type == angle::RADIAN)
        {
            value = radian_to_degree(float(new_value));
        }
        else if (init_type == angle::GRADIAN)
        {
            value = gradian_to_degree(float(new_value));
        }
        else if (init_type == angle::TURN)
        {
            value = turn_to_degree(float(new_value));
        }
        normalize_value();
    }

angle() [6/9]

angle::angle ( long double  new_value, angle::type  init_type = angle::DEGREE  )

explicit

Constructor of angle. The value is initialized from the long double new_value casted to a float. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.

Definition at line 69 of file angle.cpp.

                                                          : value()
    {
        if (init_type == angle::DEGREE)
        {
            value = float(new_value);
        }
        else if (init_type == angle::RADIAN)
        {
            value = radian_to_degree(float(new_value));
        }
        else if (init_type == angle::GRADIAN)
        {
            value = gradian_to_degree(float(new_value));
        }
        else if (init_type == angle::TURN)
        {
            value = turn_to_degree(float(new_value));
        }
        normalize_value();
    }

angle() [7/9]

angle::angle ( int  new_value, angle::type  init_type = angle::DEGREE  )

explicit

Constructor of angle. The value is initialized from the int new_value casted to a float. init_type is not stored as a member-variable, but instead allows to select if the value is given in DEGREE or in RADIAN. By default it's in DEGREE.

Definition at line 90 of file angle.cpp.

                                                  : value()
    {
        if (init_type == angle::DEGREE)
        {
            value = float(new_value);
        }
        else if (init_type == angle::RADIAN)
        {
            value = radian_to_degree(float(new_value));
        }
        else if (init_type == angle::GRADIAN)
        {
            value = gradian_to_degree(float(new_value));
        }
        else if (init_type == angle::TURN)
        {
            value = turn_to_degree(float(new_value));
        }
        normalize_value();
    }

angle() [8/9]

angle::angle ( const string &  init_angle )

explicit

Constructor of angle. The value is initialized from the initialization string of angle, which uses the character 00B0 or the character 00BA to represent degrees.

Definition at line 111 of file angle.cpp.

                                         : value()
    {
        initialize_from_string(init_angle);
    }

angle() [9/9]

angle::angle ( const scalar_unit &  x )

explicit

Constructor of angle. The value is initialized from the scalar_unit x, if the scalar_unit has empty dimensions.

Definition at line 116 of file angle.cpp.

    {
        if (x.has_empty_dimensions())
        {
            value = float(x);
            normalize_value();
        }
        else
        {
            cerr << "An angle cannot be initialized with dimensions" << endl;
            value = 0.0f;
        }
    }

Member Function Documentation

display()

string angle::display

(

int

number_of_decimals = 2

)

const

Creates an string from the angle, with the value and the degrees symbol.

Definition at line 261 of file angle.cpp.

    {
        ostringstream output;
        if (get_value() == -0)
        {
            output << 0;
        }
        else
        {
            output << display_float(get_value(),number_of_decimals);
        }
        output << "°";
        return output.str();
    }

get_degree()

float angle::get_degree ( ) const

inline

Gets the value of the angle in degrees.

Definition at line 201 of file angle.hpp.

            {
                return value;
            }

get_radian()

float angle::get_radian ( ) const

inline

Gets the value of the angle in radians.

Definition at line 206 of file angle.hpp.

            {
                return degree_to_radian(value);
            }

get_value()

const float & angle::get_value ( ) const

inline

Gets the value of the angle, in degrees.

Definition at line 102 of file angle.hpp.

            {
                return value;
            }

initialize_from_string()

void angle::initialize_from_string ( string  init_angle )

protected

Internal function. Sets the value of the angle to a new value using the initialization string of angles.

Definition at line 297 of file angle.cpp.

    {
        if (init_angle.length() >= 5 and init_angle.substr(init_angle.length() - 4) == " deg")
        {
            value = stof(init_angle.substr(0,init_angle.length() - 4));
            normalize_value();
            return;
        }
        else if (init_angle.length() >= 5 and init_angle.substr(init_angle.length() - 4) == " rad")
        {
            value = radian_to_degree(stof(init_angle.substr(0,init_angle.length() - 4)));
            normalize_value();
            return;
        }
        else if (init_angle.length() >= 6 and init_angle.substr(init_angle.length() - 5) == " grad")
        {
            value = gradian_to_degree(stof(init_angle.substr(0,init_angle.length() - 5)));
            normalize_value();
            return;
        }
        else if (init_angle.length() >= 4 and init_angle.substr(init_angle.length() - 3) == " tr")
        {
            value = turn_to_degree(stof(init_angle.substr(0,init_angle.length() - 3)));
            normalize_value();
            return;
        }
        icu::UnicodeString init_angle_unicode = icu::UnicodeString(init_angle.c_str());
        if (init_angle_unicode.endsWith(0x00B0) or init_angle_unicode.endsWith(0x00BA) or init_angle_unicode.endsWith(0x03B8) or init_angle_unicode.endsWith(0x03A6))
        {
            value = stof(init_angle);
            normalize_value();
        }
    }

invert()

void angle::invert

(

)

Inverts the angle to the opposite direction in a 2D plane, which is to add 180 degrees. The value is normalized after.

Definition at line 250 of file angle.cpp.

    {
        value += 180.0f;
        normalize_value();
    }

normalize_value()

void angle::normalize_value ( )

private

Internal function. Normalizes the value, which means to maintain the same angle within 0 and 360. If the value is lower or greather it gets converted to their equivalent counterpart within this range.

Definition at line 276 of file angle.cpp.

    {
        if(isfinite(value))
        {
            if (value >= 360.0f)
            {
                while (value >= 360.0f)
                {
                    value -= 360.0f;
                }
            }
            else if (value < 0.0f)
            {
                while (value < 0.0f)
                {
                    value += 360.0f;
                }
            }
        }
    }

operator float()

angle::operator float ( ) const

inlineexplicit

Cast angle to a float.

Definition at line 97 of file angle.hpp.

            {
                return float(value);
            }

operator*() [1/2]

angle angle::operator*

(

const angle &

x

)

const

Creates a new angle as the multiplication of other two.

Definition at line 179 of file angle.cpp.

    {
        return angle(value * x.get_value());
    }

operator*() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

angle angle::operator* ( T  x ) const

inline

Creates a new angle as the multiplication of a numeric type with the value of this angle.

Definition at line 138 of file angle.hpp.

            {
                return angle(value * x);
            }

operator*=() [1/2]

void angle::operator*=

(

const angle &

x

)

Multiplies the value of this angle with the value of angle x. The value is normalized after.

Definition at line 206 of file angle.cpp.

    {
        value *= x.get_value();
        normalize_value();
    }

operator*=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void angle::operator*= ( T  x )

inline

Multiplies a numeric type to the value of this angle.

Definition at line 170 of file angle.hpp.

            {
                value *= x;
                normalize_value();
            }

operator+() [1/2]

angle angle::operator+

(

const angle &

x

)

const

Creates a new angle as the sum of other two.

Definition at line 169 of file angle.cpp.

    {
        return angle(value + x.get_value());
    }

operator+() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

angle angle::operator+ ( T  x ) const

inline

Creates a new angle as the sum of a numeric type with the value of this angle.

Definition at line 126 of file angle.hpp.

            {
                return angle(value + x);
            }

operator++() [1/2]

angle & angle::operator++

(

)

Increments the value by one.

Definition at line 224 of file angle.cpp.

    {
        value++;
        return *this;
    }

operator++() [2/2]

angle angle::operator++

(

int

)

Increments the value by one.

Definition at line 230 of file angle.cpp.

    {
        angle tmp = angle(*this);
        operator ++();
        return tmp;
    }

operator+=() [1/2]

void angle::operator+=

(

const angle &

x

)

Sums the value of the angle x to the value of this angle. The value is normalized after.

Definition at line 194 of file angle.cpp.

    {
        value += x.get_value();
        normalize_value();
    }

operator+=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void angle::operator+= ( T  x )

inline

Sums a numeric type to the value of this angle.

Definition at line 156 of file angle.hpp.

            {
                value += x;
                normalize_value();
            }

operator-() [1/2]

angle angle::operator-

(

const angle &

x

)

const

Creates a new angle as the substraction of this angle and another angle x.

Definition at line 174 of file angle.cpp.

    {
        return angle(value - x.get_value());
    }

operator-() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

angle angle::operator- ( T  x ) const

inline

Creates a new angle as the substraction of the value of this angle with a numeric type.

Definition at line 132 of file angle.hpp.

            {
                return angle(value - x);
            }

operator--() [1/2]

angle & angle::operator--

(

)

Decrements the value by one.

Definition at line 237 of file angle.cpp.

    {
        value--;
        return *this;
    }

operator--() [2/2]

angle angle::operator--

(

int

)

Decrements the value by one.

Definition at line 243 of file angle.cpp.

    {
        angle tmp = angle(*this);
        operator --();
        return tmp;
    }

operator-=() [1/2]

void angle::operator-=

(

const angle &

x

)

Substract the value of the angle x to the value of this angle. The value is normalized after.

Definition at line 200 of file angle.cpp.

    {
        value -= x.get_value();
        normalize_value();
    }

operator-=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void angle::operator-= ( T  x )

inline

Substracts a numeric type to the value of this angle.

Definition at line 163 of file angle.hpp.

            {
                value -= x;
                normalize_value();
            }

operator/() [1/2]

angle angle::operator/

(

const angle &

x

)

const

Creates a new angle as the division of this angle and another angle x.

Definition at line 184 of file angle.cpp.

    {
        return angle(value / x.get_value());
    }

operator/() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

angle angle::operator/ ( T  x ) const

inline

Creates a new angle as the division of a numeric type with the value of this angle.

Definition at line 144 of file angle.hpp.

            {
                return angle(value / x);
            }

operator/=() [1/2]

void angle::operator/=

(

const angle &

x

)

Divides the value of this angle with the value of angle x. The value is normalized after.

Definition at line 212 of file angle.cpp.

    {
        value /= x.get_value();
        normalize_value();
    }

operator/=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void angle::operator/= ( T  x )

inline

Divides a numeric type to the value of this angle.

Definition at line 177 of file angle.hpp.

            {
                value /= x;
                normalize_value();
            }

operator=() [1/6]

angle & angle::operator=

(

angle &&

x

)

Move assignment of angle. The value is moved from the value of angle x.

Definition at line 136 of file angle.cpp.

    {
        value = std::move(x.get_value());
        return *this;
    }

operator=() [2/6]

angle & angle::operator=

(

const angle &

x

)

Copy assignment of angle. The value is copied to the value of angle x.

Definition at line 130 of file angle.cpp.

    {
        value = x.get_value();
        return *this;
    }

operator=() [3/6]

angle & angle::operator=

(

const scalar_unit &

x

)

Assignment operator. The value of the angle is set to the value of the scalar_unit x, only if the scalar_unit has empty dimensions.

Definition at line 155 of file angle.cpp.

    {
        if (x.has_empty_dimensions())
        {
            value = x.get_value();
            normalize_value();
        }
        else
        {
            cerr << "An angle cannot be initialized with dimensions" << endl;
        }
        return *this;
    }

operator=() [4/6]

angle & angle::operator=

(

const string &

init_angle

)

Assignment operator. An initialization string is used to set the value, which contains the character 00B0 or the character 00BA to represent degrees.

Definition at line 149 of file angle.cpp.

    {
        initialize_from_string(init_angle);
        return *this;
    }

operator=() [5/6]

angle & angle::operator=

(

float

new_value

)

Assignment operator. The value is copied from the float.

Definition at line 142 of file angle.cpp.

    {
        value = new_value;
        normalize_value();
        return *this;
    }

operator=() [6/6]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void angle::operator= ( T  new_value )

inline

Sets the value to the value of some numeric type, casting it to a float first, and normalizing the value after that.

Definition at line 119 of file angle.hpp.

            {
                value = float(new_value);
                normalize_value();
            }

operator^() [1/2]

angle angle::operator^

(

const angle &

x

)

const

Creates a new angle by powering the angle class with the value of another angle x.

Definition at line 189 of file angle.cpp.

    {
        return angle(std::pow(value,x.get_value()));
    }

operator^() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

angle angle::operator^ ( T  x ) const

inline

Creates a new angle as the power of the value of this angle with a numeric type.

Definition at line 150 of file angle.hpp.

            {
                return angle(std::pow(value, x));
            }

operator^=() [1/2]

void angle::operator^=

(

const angle &

x

)

Powers the value of this angle with the value of angle x. The value is normalized after.

Definition at line 218 of file angle.cpp.

    {
        value = std::pow(value,x.get_value());
        normalize_value();
    }

operator^=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void angle::operator^= ( T  x )

inline

Powers a numeric type to the value of this angle.

Definition at line 184 of file angle.hpp.

            {
                value = std::pow(value, x);
                normalize_value();
            }

to_scalar_unit()

scalar_unit angle::to_scalar_unit

(

)

const

Creates a scalar_unit with the same value and degree dimensions.

Definition at line 256 of file angle.cpp.

    {
        return scalar_unit(value, { dimension(dimension::DEGREE, prefix::NONE, dimension::NUMERATOR) });
    }

Member Data Documentation

value

angle::value

protected

Value of the angle. It is stored in degrees.

Definition at line 212 of file angle.hpp.

---

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

• meca_number/angle.hpp
• meca_number/angle.cpp
• docs/dox/meca_number/angle.dox