Wraps floating (double) value with some helper functions. More...

#include <Double.h>

Public Member Functions
constexpr	Double () noexcept
	Construct a null Double.

constexpr	Double (double x) noexcept
	Construct a Double with a value.

constexpr double	toDouble () const noexcept
	Get Double value. More...

bool	isInfinity () const noexcept
	Check if value is infinity (+infinity or -infinity)

constexpr void	setMinusInfinity () noexcept
	Set -infinity.

bool	isMinusInfinity () const noexcept
	Check if value is -infinity.

constexpr void	setPlusInfinity () noexcept
	Set +infinity.

bool	isPlusInfinity () const noexcept
	Check if value is +infinity.

bool	isNaN () const noexcept
	Check if value is NaN. More...

bool	isNull () const noexcept
	Check if Double is null. More...

constexpr void	clear () noexcept
	Clear.

constexpr Double	operator- () const
	Negation operator. More...

Friends
bool	operator== (const Double &x, const Double &y) noexcept
	Equality comparison operator. More...

bool	operator!= (const Double &x, const Double &y) noexcept
	Inequality comparison operator. More...

bool	operator< (const Double &x, const Double &y) noexcept
	Comparison operator. More...

bool	operator<= (const Double &x, const Double &y) noexcept
	Comparison operator. More...

bool	operator> (const Double &x, const Double &y) noexcept
	Comparison operator. More...

bool	operator>= (const Double &x, const Double &y) noexcept
	Comparison operator. More...

constexpr Double	operator+ (const Double &x, const Double &y)
	Addition operator. More...

constexpr Double	operator- (const Double &x, const Double &y)
	Substraction operator. More...

constexpr Double	operator* (const Double &x, const Double &y)
	Multiplication operator. More...

constexpr Double	operator/ (const Double &x, const Double &y)
	Division operator. More...

Detailed Description

Wraps floating (double) value with some helper functions.

Definition at line 31 of file Double.h.

Member Function Documentation

bool Mdt::Numeric::Double::isNaN ( ) const

inlinenoexcept

Check if value is NaN.

Internally, std::isnan() is used

Definition at line 101 of file Double.h.

bool Mdt::Numeric::Double::isNull ( ) const

inlinenoexcept

Check if Double is null.

See also: isNaN()

Definition at line 110 of file Double.h.

constexpr Double Mdt::Numeric::Double::operator- ( ) const

inline

Negation operator.

Note:

If current value is null, a null value will be returned (Same rule as IEEE 754 NaN)
For all other cases, standard floating point arithmetic rules apply

Definition at line 223 of file Double.h.

constexpr double Mdt::Numeric::Double::toDouble ( ) const

inlinenoexcept

Get Double value.

Returns the value in standard double format. The name was choosen to be explicit, but no convertion is done.

Definition at line 51 of file Double.h.

Friends And Related Function Documentation

bool operator!=	(	const Double &	x,
		const Double &	y
	)

friend

Inequality comparison operator.

See also: operator==()

Definition at line 144 of file Double.h.

constexpr Double operator*	(	const Double &	x,
		const Double &	y
	)

friend

Multiplication operator.

Note:

If one (or both) value is null, a null value will be returned (Same rule as IEEE 754 NaN)
For all other cases, standard floating point arithmetic rules apply

Definition at line 235 of file Double.h.

constexpr Double operator+	(	const Double &	x,
		const Double &	y
	)

friend

Addition operator.

Note:

If one (or both) value is null, a null value will be returned (Same rule as IEEE 754 NaN)
For all other cases, standard floating point arithmetic rules apply

Definition at line 200 of file Double.h.

constexpr Double operator-	(	const Double &	x,
		const Double &	y
	)

friend

Substraction operator.

Note:

If one (or both) value is null, a null value will be returned (Same rule as IEEE 754 NaN)
For all other cases, standard floating point arithmetic rules apply

Definition at line 212 of file Double.h.

constexpr Double operator/	(	const Double &	x,
		const Double &	y
	)

friend

Division operator.

Note:

If one (or both) value is null, a null value will be returned (Same rule as IEEE 754 NaN)
For all other cases, standard floating point arithmetic rules apply

Definition at line 247 of file Double.h.

bool operator<	(	const Double &	x,
		const Double &	y
	)

friend

Comparison operator.

Note: if one (or both) value is null, comparison will allways be false (Same rule as IEEE 754 NaN)

Definition at line 155 of file Double.h.

bool operator<=	(	const Double &	x,
		const Double &	y
	)

friend

Comparison operator.

Note: if one (or both) value is null, comparison will allways be false (Same rule as IEEE 754 NaN)

Definition at line 166 of file Double.h.

bool operator==	(	const Double &	x,
		const Double &	y
	)

friend

Equality comparison operator.

The comparison is a approximation. x and y are considered equal if $|x-y| < \epsilon$

Notes:

if one (or both) value is null, they are not considered equal (Same rule as IEEE 754 NaN)

Definition at line 131 of file Double.h.

bool operator>	(	const Double &	x,
		const Double &	y
	)

friend

Comparison operator.

Note: if one (or both) value is null, comparison will allways be false (Same rule as IEEE 754 NaN)

Definition at line 177 of file Double.h.

bool operator>=	(	const Double &	x,
		const Double &	y
	)

friend

Comparison operator.

Note: if one (or both) value is null, comparison will allways be false (Same rule as IEEE 754 NaN)

Definition at line 188 of file Double.h.

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

libs/Numeric/src/Mdt/Numeric/Double.h

Public Member Functions

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation