angle.hpp File Reference

#include "../units/constants.hpp"
#include "../util/is_number.hpp"
#include "../units/scalar_unit.hpp"
#include <cmath>
#include <numbers>
#include <string>

Include dependency graph for angle.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Namespaces
namespace	scifir
	The namespace scifir contains all scifir-units, excepting the string literals, which are outside.

Functions
float	scifir::radian_to_degree (float x)
	Converts a radian to degree.
float	scifir::gradian_to_degree (float x)
float	scifir::turn_to_degree (float x)
float	scifir::degree_to_radian (float x)
	Converts a degree to a radian.
float	scifir::gradian_to_radian (float x)
float	scifir::turn_to_radian (float x)
float	scifir::degree_to_gradian (float x)
float	scifir::radian_to_gradian (float x)
float	scifir::turn_to_gradian (float x)
float	scifir::degree_to_turn (float x)
float	scifir::radian_to_turn (float x)
float	scifir::gradian_to_turn (float x)
string	scifir::to_string (const angle &x)
	Converts an angle to their string representation.
bool	scifir::is_angle (const string &init_angle)
	Checks if some string is an initialization string of an angle.
bool	scifir::parallel (const angle &x, const angle &y)
	Checks if two angles in a 2D correspond to parallel lines (or parallel vectors).
bool	scifir::orthogonal (const angle &x, const angle &y)
	Checks if two angles in a 2D correspond to orthogonal lines (or orthogonal vectors).
angle	scifir::sqrt (const angle &x)
	Calculates the square root of the angle x and returns that new angle.
angle	scifir::sqrt_nth (const angle &x, int index)
	Calculates the nth root of the angle x and returns that new angle.
float	scifir::sin (const angle &x)
	Calculates the sin of angle x. It uses the sin() function of the standard library of C++, the difference is that angle is in degrees, not in radians.
float	scifir::cos (const angle &x)
	Calculates the cos of angle x. It uses the cos() function of the standard library of C++, the difference is that angle is in degrees, not in radians.
float	scifir::tan (const angle &x)
	Calculates the tan of angle x. It uses the tan() function of the standard library of C++, the difference is that angle is in degrees, not in radians.
angle	scifir::asin (float x)
	Calculates the asin of some value x and returns the result as angle in degrees.
angle	scifir::acos (float x)
	Calculates the acos of some value x and returns the result as angle in degrees.
angle	scifir::atan (float x)
	Calculates the atan of some value x and returns the result as angle in degrees.
angle	scifir::atan2 (float y, float x)
float	scifir::sinh (const angle &x)
	Calculates the sinh of angle x. It uses the sinh() function of the standard library of C++, the difference is that angle is in degrees, not in radians.
float	scifir::cosh (const angle &x)
	Calculates the cosh of angle x. It uses the cosh() function of the standard library of C++, the difference is that angle is in degrees, not in radians.
float	scifir::tanh (const angle &x)
	Calculates the tanh of angle x. It uses the tanh() function of the standard library of C++, the difference is that angle is in degrees, not in radians.
angle	scifir::asinh (float x)
	Calculates the asinh of some value x and returns the result as angle in degrees.
angle	scifir::acosh (float x)
	Calculates the acosh of some value x and returns the result as angle in degrees.
angle	scifir::atanh (float x)
	Calculates the atanh of some value x and returns the result as angle in degrees.
float	scifir::asin_degree (float x)
	Calculates the asin receiving x in degrees. It uses the asin() function of the standard library of C++, but the difference is that the argument is in degrees, not in radians.
float	scifir::acos_degree (float x)
	Calculates the acos receiving x in degrees. It uses the acos() function of the standard library of C++, but the difference is that the argument is in degrees, not in radians.
float	scifir::atan_degree (float x)
	Calculates the atan receiving x in degrees. It uses the atan() function of the standard library of C++, but the difference is that the argument is in degrees, not in radians.
float	scifir::asinh_degree (float x)
	Calculates the asinh receiving x in degrees. It uses the asinh() function of the standard library of C++, but the difference is that the argument is in degrees, not in radians.
float	scifir::acosh_degree (float x)
	Calculates the acosh receiving x in degrees. It uses the acosh() function of the standard library of C++, but the difference is that the argument is in degrees, not in radians.
float	scifir::atanh_degree (float x)
	Calculates the atanh receiving x in degrees. It uses the atanh() function of the standard library of C++, but the difference is that the argument is in degrees, not in radians.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scifir::angle	operator+ (T x, const scifir::angle &y)
	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>
scifir::angle	operator- (T x, const scifir::angle &y)
	Creates a new angle as the substraction of the numeric type with the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scifir::angle	operator* (T x, const scifir::angle &y)
	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>
scifir::angle	operator/ (T x, const scifir::angle &y)
	Creates a new angle as the division of the value of this angle with the numeric type.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
scifir::angle	operator^ (T x, const scifir::angle &y)
	Creates a new angle as the power of a numeric type with the value of this angle.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator== (T x, const scifir::angle &y)
	Checks if the value of angle y is equal to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator!= (T x, const scifir::angle &y)
	Checks if the value of angle y is not equal to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator< (T x, const scifir::angle &y)
	Checks if the value of angle y is greather to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator> (T x, const scifir::angle &y)
	Checks if the value of angle y is lower to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator<= (T x, const scifir::angle &y)
	Checks if the value of angle y is equal or greather than a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator>= (T x, const scifir::angle &y)
	Checks if the value of angle y is lower or equal than a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator== (const scifir::angle &y, T x)
	Checks if the value of angle y is equal to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator!= (const scifir::angle &y, T x)
	Checks if the value of angle y is not equal to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator< (const scifir::angle &y, T x)
	Checks if the value of angle y is lower to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator> (const scifir::angle &y, T x)
	Checks if the value of angle y is greather to a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator<= (const scifir::angle &y, T x)
	Checks if the value of angle y is lower or equal than a numeric type x.
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
bool	operator>= (const scifir::angle &y, T x)
	Checks if the value of angle y is equal or greather than a numeric type x.
bool	operator== (const scifir::angle &x, const scifir::angle &y)
	Checks if two angles have equal value.
bool	operator!= (const scifir::angle &x, const scifir::angle &y)
	Checks if two angles have not equal value.
bool	operator< (const scifir::angle &x, const scifir::angle &y)
	Checks if the value of angle x is lower than the value of angle y.
bool	operator> (const scifir::angle &x, const scifir::angle &y)
	Checks if the value of angle x is greather than the value of angle y.
bool	operator<= (const scifir::angle &x, const scifir::angle &y)
	Checks if the value of angle x is lower or equal than the value of angle y.
bool	operator>= (const scifir::angle &x, const scifir::angle &y)
	Checks if the value of angle x is equal or greather than the value of angle y.
bool	operator== (const scifir::angle &x, const string &init_angle)
	Checks if the angle x is equal than the angle initialized with the initialization string of angle init_angle.
bool	operator!= (const scifir::angle &x, const string &init_angle)
	Checks if the angle x is not equal than the angle initialized with the initialization string of angle init_angle.
bool	operator== (const string &init_angle, const scifir::angle &x)
	Checks if the angle x is equal than the angle initialized with the initialization string of angle init_angle.
bool	operator!= (const string &init_angle, const scifir::angle &x)
	Checks if the angle x is not equal than the angle initialized with the initialization string of angle init_angle.
void	operator+= (string &x, const scifir::angle &y)
	Concatenates to string x the string representation of angle y.
string	operator+ (const string &x, const scifir::angle &y)
	Concatenates the string x with the string representation of angle y into a new string.
string	operator+ (const scifir::angle &y, const string &x)
	Concatenates the string x with the string representation of angle y into a new string.
ostream &	operator<< (ostream &os, const scifir::angle &x)
	Sends the string representation of angle x to an output stream.
istream &	operator>> (istream &is, scifir::angle &x)
	Initializes an angle with an initialization string obtained from an input stream.

Function Documentation

operator!=() [1/5]

bool operator!=	(	const scifir::angle &	x,
		const scifir::angle &	y
	)

Checks if two angles have not equal value.

Definition at line 504 of file angle.cpp.

{
    return !(x == y);
}

operator!=() [2/5]

bool operator!=	(	const scifir::angle &	x,
		const string &	init_angle
	)

Checks if the angle x is not equal than the angle initialized with the initialization string of angle init_angle.

Definition at line 549 of file angle.cpp.

{
    return !(x == init_angle);
}

operator!=() [3/5]

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

bool operator!=	(	const scifir::angle &	y,
		T	x
	)

Checks if the value of angle y is not equal to a numeric type x.

Definition at line 346 of file angle.hpp.

{
    return (x != y.get_value());
}

operator!=() [4/5]

bool operator!=	(	const string &	init_angle,
		const scifir::angle &	x
	)

Checks if the angle x is not equal than the angle initialized with the initialization string of angle init_angle.

Definition at line 560 of file angle.cpp.

{
    return !(init_angle == x);
}

operator!=() [5/5]

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

bool operator!=	(	T	x,
		const scifir::angle &	y
	)

Checks if the value of angle y is not equal to a numeric type x.

Definition at line 310 of file angle.hpp.

{
    return (x != y.get_value());
}

operator*()

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

scifir::angle operator*	(	T	x,
		const scifir::angle &	y
	)

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

Definition at line 286 of file angle.hpp.

{
    return scifir::angle(x * y.get_value());
}

operator+() [1/3]

string operator+	(	const scifir::angle &	y,
		const string &	x
	)

Concatenates the string x with the string representation of angle y into a new string.

Definition at line 580 of file angle.cpp.

{
    ostringstream output;
    output << y;
    output << x;
    return output.str();
}

operator+() [2/3]

string operator+	(	const string &	x,
		const scifir::angle &	y
	)

Concatenates the string x with the string representation of angle y into a new string.

Definition at line 572 of file angle.cpp.

{
    ostringstream output;
    output << x;
    output << y;
    return output.str();
}

operator+() [3/3]

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

scifir::angle operator+	(	T	x,
		const scifir::angle &	y
	)

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

Definition at line 274 of file angle.hpp.

{
    return scifir::angle(x + y.get_value());
}

operator+=()

void operator+=	(	string &	x,
		const scifir::angle &	y
	)

Concatenates to string x the string representation of angle y.

Definition at line 565 of file angle.cpp.

{
    ostringstream output;
    output << y;
    x += output.str();
}

operator-()

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

scifir::angle operator-	(	T	x,
		const scifir::angle &	y
	)

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

Definition at line 280 of file angle.hpp.

{
    return scifir::angle(x - y.get_value());
}

operator/()

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

scifir::angle operator/	(	T	x,
		const scifir::angle &	y
	)

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

Definition at line 292 of file angle.hpp.

{
    return scifir::angle(x / y.get_value());
}

operator<() [1/3]

bool operator<	(	const scifir::angle &	x,
		const scifir::angle &	y
	)

Checks if the value of angle x is lower than the value of angle y.

Definition at line 509 of file angle.cpp.

{
    if(x.get_value() < y.get_value())
    {
        return true;
    }
    else
    {
        return false;
    }
}

operator<() [2/3]

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

bool operator<	(	const scifir::angle &	y,
		T	x
	)

Checks if the value of angle y is lower to a numeric type x.

Definition at line 352 of file angle.hpp.

{
    return (y.get_value() < x);
}

operator<() [3/3]

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

bool operator<	(	T	x,
		const scifir::angle &	y
	)

Checks if the value of angle y is greather to a numeric type x.

Definition at line 316 of file angle.hpp.

{
    return (x < y.get_value());
}

operator<<()

ostream & operator<<	(	ostream &	os,
		const scifir::angle &	x
	)

Sends the string representation of angle x to an output stream.

Definition at line 588 of file angle.cpp.

{
    return os << to_string(x);
}

operator<=() [1/3]

bool operator<=	(	const scifir::angle &	x,
		const scifir::angle &	y
	)

Checks if the value of angle x is lower or equal than the value of angle y.

Definition at line 533 of file angle.cpp.

{
    return !(x > y);
}

operator<=() [2/3]

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

bool operator<=	(	const scifir::angle &	y,
		T	x
	)

Checks if the value of angle y is lower or equal than a numeric type x.

Definition at line 364 of file angle.hpp.

{
    return (y.get_value() <= x);
}

operator<=() [3/3]

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

bool operator<=	(	T	x,
		const scifir::angle &	y
	)

Checks if the value of angle y is equal or greather than a numeric type x.

Definition at line 328 of file angle.hpp.

{
    return (x <= y.get_value());
}

operator==() [1/5]

bool operator==	(	const scifir::angle &	x,
		const scifir::angle &	y
	)

Checks if two angles have equal value.

Definition at line 492 of file angle.cpp.

{
    if(x.get_value() == y.get_value())
    {
        return true;
    }
    else
    {
        return false;
    }
}

operator==() [2/5]

bool operator==	(	const scifir::angle &	x,
		const string &	init_angle
	)

Checks if the angle x is equal than the angle initialized with the initialization string of angle init_angle.

Definition at line 543 of file angle.cpp.

{
    scifir::angle y = scifir::angle(init_angle);
    return (x == y);
}

operator==() [3/5]

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

bool operator==	(	const scifir::angle &	y,
		T	x
	)

Checks if the value of angle y is equal to a numeric type x.

Definition at line 340 of file angle.hpp.

{
    return (x == y.get_value());
}

operator==() [4/5]

bool operator==	(	const string &	init_angle,
		const scifir::angle &	x
	)

Checks if the angle x is equal than the angle initialized with the initialization string of angle init_angle.

Definition at line 554 of file angle.cpp.

{
    scifir::angle y = scifir::angle(init_angle);
    return (x == y);
}

operator==() [5/5]

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

bool operator==	(	T	x,
		const scifir::angle &	y
	)

Checks if the value of angle y is equal to a numeric type x.

Definition at line 304 of file angle.hpp.

{
    return (x == y.get_value());
}

operator>() [1/3]

bool operator>	(	const scifir::angle &	x,
		const scifir::angle &	y
	)

Checks if the value of angle x is greather than the value of angle y.

Definition at line 521 of file angle.cpp.

{
    if(x.get_value() > y.get_value())
    {
        return true;
    }
    else
    {
        return false;
    }
}

operator>() [2/3]

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

bool operator>	(	const scifir::angle &	y,
		T	x
	)

Checks if the value of angle y is greather to a numeric type x.

Definition at line 358 of file angle.hpp.

{
    return (y.get_value() > x);
}

operator>() [3/3]

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

bool operator>	(	T	x,
		const scifir::angle &	y
	)

Checks if the value of angle y is lower to a numeric type x.

Definition at line 322 of file angle.hpp.

{
    return (x > y.get_value());
}

operator>=() [1/3]

bool operator>=	(	const scifir::angle &	x,
		const scifir::angle &	y
	)

Checks if the value of angle x is equal or greather than the value of angle y.

Definition at line 538 of file angle.cpp.

{
    return !(x < y);
}

operator>=() [2/3]

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

bool operator>=	(	const scifir::angle &	y,
		T	x
	)

Checks if the value of angle y is equal or greather than a numeric type x.

Definition at line 370 of file angle.hpp.

{
    return (y.get_value() >= x);
}

operator>=() [3/3]

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

bool operator>=	(	T	x,
		const scifir::angle &	y
	)

Checks if the value of angle y is lower or equal than a numeric type x.

Definition at line 334 of file angle.hpp.

{
    return (x >= y.get_value());
}

operator>>()

istream & operator>>	(	istream &	is,
		scifir::angle &	x
	)

Initializes an angle with an initialization string obtained from an input stream.

Definition at line 593 of file angle.cpp.

{
    char a[256];
    is.getline(a, 256);
    string b(a);
    boost::trim(b);
    x = scifir::angle(b);
    return is;
}

operator^()

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

scifir::angle operator^	(	T	x,
		const scifir::angle &	y
	)

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

Definition at line 298 of file angle.hpp.

{
    return scifir::angle(pow(x, y.get_value()));
}