Extra traits which extend numeric limits. More...

#include <scalar.h>

Classes
struct	demoted
	Demoted type for long double. More...

struct	promoted
	Promoted type. More...

Public Member Functions
template<>
long double	pi ()
	Pi for long double. More...

template<>
long double	ln_2 ()
	log(2) for long double More...

template<>
float	to_scalar_t (const Other_Scalar_T &val)
	Extra traits which extend numeric limits. More...

template<>
double	to_scalar_t (const Other_Scalar_T &val)
	Cast to double. More...

template<>
long double	to_scalar_t (const dd_real &val)
	Cast to long double. More...

template<>
long double	to_scalar_t (const qd_real &val)
	Cast to long double. More...

template<>
dd_real	to_scalar_t (const long double &val)
	Cast to dd_real. More...

template<>
dd_real	to_scalar_t (const qd_real &val)
	Cast to dd_real. More...

template<>
qd_real	to_scalar_t (const long double &val)
	Cast to qd_real. More...

template<>
qd_real	to_scalar_t (const dd_real &val)
	Cast to qd_real. More...

Static Public Member Functions
static bool	isInf (const Scalar_T &val)
	Smart isinf. More...

static bool	isNaN (const Scalar_T &val)
	Smart isnan. More...

static bool	isNaN_or_isInf (const Scalar_T &val)
	Smart isnan or isinf. More...

static Scalar_T	NaN ()
	Smart NaN. More...

static int	to_int (const Scalar_T &val)
	Cast to int. More...

static double	to_double (const Scalar_T &val)
	Cast to double. More...

template<typename Other_Scalar_T >
static Scalar_T	to_scalar_t (const Other_Scalar_T &val)
	Cast to Scalar_T. More...

static Scalar_T	fmod (const Scalar_T &lhs, const Scalar_T &rhs)
	Modulo function for scalar. More...

static Scalar_T	conj (const Scalar_T &val)
	Complex conjugate of scalar. More...

static Scalar_T	real (const Scalar_T &val)
	Real part of scalar. More...

static Scalar_T	imag (const Scalar_T &val)
	Imaginary part of scalar. More...

static Scalar_T	abs (const Scalar_T &val)
	Absolute value of scalar. More...

static Scalar_T	pi ()
	Pi. More...

static Scalar_T	ln_2 ()
	log(2) More...

static Scalar_T	pow (const Scalar_T &val, int n)
	Integer power. More...

static Scalar_T	sqrt (const Scalar_T &val)
	Square root of scalar. More...

static Scalar_T	exp (const Scalar_T &val)
	Exponential. More...

static Scalar_T	log (const Scalar_T &val)
	Logarithm of scalar. More...

static Scalar_T	log2 (const Scalar_T &val)
	Log base 2. More...

static Scalar_T	cos (const Scalar_T &val)
	Cosine of scalar. More...

static Scalar_T	acos (const Scalar_T &val)
	Inverse cosine of scalar. More...

static Scalar_T	cosh (const Scalar_T &val)
	Hyperbolic cosine of scalar. More...

static Scalar_T	sin (const Scalar_T &val)
	Sine of scalar. More...

static Scalar_T	asin (const Scalar_T &val)
	Inverse sine of scalar. More...

static Scalar_T	sinh (const Scalar_T &val)
	Hyperbolic sine of scalar. More...

static Scalar_T	tan (const Scalar_T &val)
	Tangent of scalar. More...

static Scalar_T	atan (const Scalar_T &val)
	Inverse tangent of scalar. More...

static Scalar_T	tanh (const Scalar_T &val)
	Hyperbolic tangent of scalar. More...

Static Private Member Functions
static bool	isInf (const Scalar_T &val, bool_to_type< false >)
	Smart isinf specialised for Scalar_T without infinity. More...

static bool	isInf (const Scalar_T &val, bool_to_type< true >)
	Smart isinf specialised for Scalar_T with infinity. More...

static bool	isNaN (const Scalar_T &val, bool_to_type< false >)
	Smart isnan specialised for Scalar_T without quiet NaN. More...

static bool	isNaN (const Scalar_T &val, bool_to_type< true >)
	Smart isnan specialised for Scalar_T with quiet NaN. More...

Detailed Description

template<typename Scalar_T>
class glucat::numeric_traits< Scalar_T >

Extra traits which extend numeric limits.

Definition at line 46 of file scalar.h.

Member Function Documentation

◆ abs()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::abs ( const Scalar_T & val )

inlinestatic

Absolute value of scalar.

Definition at line 181 of file scalar.h.

References UBLAS_ABS.

◆ acos()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::acos ( const Scalar_T & val )

inlinestatic

Inverse cosine of scalar.

Definition at line 244 of file scalar.h.

References glucat::acos().

◆ asin()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::asin ( const Scalar_T & val )

inlinestatic

Inverse sine of scalar.

Definition at line 265 of file scalar.h.

References glucat::asin().

◆ atan()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::atan ( const Scalar_T & val )

inlinestatic

Inverse tangent of scalar.

Definition at line 286 of file scalar.h.

References glucat::atan().

◆ conj()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::conj ( const Scalar_T & val )

inlinestatic

Complex conjugate of scalar.

Definition at line 160 of file scalar.h.

◆ cos()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::cos ( const Scalar_T & val )

inlinestatic

Cosine of scalar.

Definition at line 237 of file scalar.h.

References glucat::cos().

◆ cosh()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::cosh ( const Scalar_T & val )

inlinestatic

Hyperbolic cosine of scalar.

Definition at line 251 of file scalar.h.

References glucat::cosh().

◆ exp()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::exp ( const Scalar_T & val )

inlinestatic

Exponential.

Definition at line 216 of file scalar.h.

References glucat::exp().

◆ fmod()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::fmod	(	const Scalar_T &	lhs,
		const Scalar_T &	rhs
	)

inlinestatic

Modulo function for scalar.

Definition at line 153 of file scalar.h.

◆ imag()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::imag ( const Scalar_T & val )

inlinestatic

Imaginary part of scalar.

Definition at line 174 of file scalar.h.

◆ isInf() [1/3]

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isInf	(	const Scalar_T &	val,
		bool_to_type< false >
	)

inlinestaticprivate

Smart isinf specialised for Scalar_T without infinity.

Definition at line 53 of file scalar.h.

Referenced by glucat::numeric_traits< Scalar_T >::isInf(), and glucat::numeric_traits< Scalar_T >::isNaN_or_isInf().

◆ isInf() [2/3]

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isInf	(	const Scalar_T &	val,
		bool_to_type< true >
	)

inlinestaticprivate

Smart isinf specialised for Scalar_T with infinity.

Definition at line 60 of file scalar.h.

References _GLUCAT_ISINF.

◆ isInf() [3/3]

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isInf ( const Scalar_T & val )

inlinestatic

Smart isinf.

Definition at line 82 of file scalar.h.

References glucat::numeric_traits< Scalar_T >::isInf().

◆ isNaN() [1/3]

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isNaN	(	const Scalar_T &	val,
		bool_to_type< false >
	)

inlinestaticprivate

Smart isnan specialised for Scalar_T without quiet NaN.

Definition at line 67 of file scalar.h.

Referenced by glucat::numeric_traits< Scalar_T >::isNaN(), and glucat::numeric_traits< Scalar_T >::isNaN_or_isInf().

◆ isNaN() [2/3]

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isNaN	(	const Scalar_T &	val,
		bool_to_type< true >
	)

inlinestaticprivate

Smart isnan specialised for Scalar_T with quiet NaN.

Definition at line 74 of file scalar.h.

References _GLUCAT_ISNAN.

◆ isNaN() [3/3]

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isNaN ( const Scalar_T & val )

inlinestatic

Smart isnan.

Definition at line 92 of file scalar.h.

References glucat::numeric_traits< Scalar_T >::isNaN().

◆ isNaN_or_isInf()

template<typename Scalar_T >

static bool glucat::numeric_traits< Scalar_T >::isNaN_or_isInf ( const Scalar_T & val )

inlinestatic

Smart isnan or isinf.

Definition at line 102 of file scalar.h.

References glucat::numeric_traits< Scalar_T >::isInf(), and glucat::numeric_traits< Scalar_T >::isNaN().

◆ ln_2() [1/2]

template<>

long double glucat::numeric_traits< long double >::ln_2 ( )

inline

log(2) for long double

Definition at line 83 of file long_double.h.

References glucat::l_ln2.

◆ ln_2() [2/2]

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::ln_2 ( )

inlinestatic

log(2)

Definition at line 195 of file scalar.h.

Referenced by glucat::numeric_traits< Scalar_T >::log2().

◆ log()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::log ( const Scalar_T & val )

inlinestatic

Logarithm of scalar.

Definition at line 223 of file scalar.h.

References glucat::log().

Referenced by glucat::numeric_traits< Scalar_T >::log2().

◆ log2()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::log2 ( const Scalar_T & val )

inlinestatic

Log base 2.

Definition at line 230 of file scalar.h.

References glucat::numeric_traits< Scalar_T >::ln_2(), and glucat::numeric_traits< Scalar_T >::log().

Referenced by glucat::log2().

◆ NaN()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::NaN ( )

inlinestatic

Smart NaN.

Definition at line 114 of file scalar.h.

References glucat::log().

Referenced by glucat::matrix::trace().

◆ pi() [1/2]

template<>

long double glucat::numeric_traits< long double >::pi ( )

inline

Pi for long double.

Definition at line 75 of file long_double.h.

References glucat::l_pi.

◆ pi() [2/2]

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::pi ( )

inlinestatic

Pi.

Definition at line 188 of file scalar.h.

Referenced by glucat::matrix::classify_eigenvalues().

◆ pow()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::pow	(	const Scalar_T &	val,
		int	n
	)

inlinestatic

Integer power.

Definition at line 202 of file scalar.h.

References glucat::pow().

◆ real()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::real ( const Scalar_T & val )

inlinestatic

Real part of scalar.

Definition at line 167 of file scalar.h.

◆ sin()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::sin ( const Scalar_T & val )

inlinestatic

Sine of scalar.

Definition at line 258 of file scalar.h.

References glucat::sin().

◆ sinh()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::sinh ( const Scalar_T & val )

inlinestatic

Hyperbolic sine of scalar.

Definition at line 272 of file scalar.h.

References glucat::sinh().

◆ sqrt()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::sqrt ( const Scalar_T & val )

inlinestatic

Square root of scalar.

Definition at line 209 of file scalar.h.

References UBLAS_SQRT.

Referenced by glucat::abs().

◆ tan()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::tan ( const Scalar_T & val )

inlinestatic

Tangent of scalar.

Definition at line 279 of file scalar.h.

References glucat::tan().

◆ tanh()

template<typename Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::tanh ( const Scalar_T & val )

inlinestatic

Hyperbolic tangent of scalar.

Definition at line 293 of file scalar.h.

References glucat::tanh().

◆ to_double()

template<typename Scalar_T >

static double glucat::numeric_traits< Scalar_T >::to_double ( const Scalar_T & val )

inlinestatic

Cast to double.

Definition at line 132 of file scalar.h.

Referenced by glucat::operator<<(), and glucat::numeric_traits< Scalar_T >::to_scalar_t().

◆ to_int()

template<typename Scalar_T >

static int glucat::numeric_traits< Scalar_T >::to_int ( const Scalar_T & val )

inlinestatic

Cast to int.

Definition at line 125 of file scalar.h.

◆ to_scalar_t() [1/9]

template<>

float glucat::numeric_traits< float >::to_scalar_t ( const Other_Scalar_T & val )

inline

Extra traits which extend numeric limits.

Cast to float

Definition at line 52 of file scalar_imp.h.

References glucat::numeric_traits< Scalar_T >::to_double().

◆ to_scalar_t() [2/9]

template<>

double glucat::numeric_traits< double >::to_scalar_t ( const Other_Scalar_T & val )

inline

Cast to double.

Definition at line 61 of file scalar_imp.h.

References glucat::numeric_traits< Scalar_T >::to_double().

◆ to_scalar_t() [3/9]

template<>

long double glucat::numeric_traits< long double >::to_scalar_t ( const dd_real & val )

inline

Cast to long double.

Definition at line 71 of file scalar_imp.h.

◆ to_scalar_t() [4/9]

template<>

long double glucat::numeric_traits< long double >::to_scalar_t ( const qd_real & val )

inline

Cast to long double.

Definition at line 80 of file scalar_imp.h.

◆ to_scalar_t() [5/9]

template<>

dd_real glucat::numeric_traits< dd_real >::to_scalar_t ( const long double & val )

inline

Cast to dd_real.

Definition at line 89 of file scalar_imp.h.

◆ to_scalar_t() [6/9]

template<>

dd_real glucat::numeric_traits< dd_real >::to_scalar_t ( const qd_real & val )

inline

Cast to dd_real.

Definition at line 98 of file scalar_imp.h.

◆ to_scalar_t() [7/9]

template<>

qd_real glucat::numeric_traits< qd_real >::to_scalar_t ( const long double & val )

inline

Cast to qd_real.

Definition at line 107 of file scalar_imp.h.

◆ to_scalar_t() [8/9]

template<>

qd_real glucat::numeric_traits< qd_real >::to_scalar_t ( const dd_real & val )

inline

Cast to qd_real.

Definition at line 116 of file scalar_imp.h.

◆ to_scalar_t() [9/9]

template<typename Scalar_T >

template<typename Other_Scalar_T >

static Scalar_T glucat::numeric_traits< Scalar_T >::to_scalar_t ( const Other_Scalar_T & val )

inlinestatic

Cast to Scalar_T.

Definition at line 140 of file scalar.h.

Referenced by glucat::matrix::nork_range(), glucat::to_demote(), and glucat::to_promote().

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

glucat/scalar.h

Classes

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Detailed Description

template<typename Scalar_T> class glucat::numeric_traits< Scalar_T >

Member Function Documentation

◆ abs()

◆ acos()

◆ asin()

◆ atan()

◆ conj()

◆ cos()

◆ cosh()

◆ exp()

◆ fmod()

◆ imag()

◆ isInf() [1/3]

◆ isInf() [2/3]

◆ isInf() [3/3]

◆ isNaN() [1/3]

◆ isNaN() [2/3]

◆ isNaN() [3/3]

◆ isNaN_or_isInf()

◆ ln_2() [1/2]

◆ ln_2() [2/2]

◆ log()

◆ log2()

◆ NaN()

◆ pi() [1/2]

◆ pi() [2/2]

◆ pow()

◆ real()

◆ sin()

◆ sinh()

◆ sqrt()

◆ tan()

◆ tanh()

◆ to_double()

◆ to_int()

◆ to_scalar_t() [1/9]

◆ to_scalar_t() [2/9]

◆ to_scalar_t() [3/9]

◆ to_scalar_t() [4/9]

◆ to_scalar_t() [5/9]

◆ to_scalar_t() [6/9]

◆ to_scalar_t() [7/9]

◆ to_scalar_t() [8/9]

◆ to_scalar_t() [9/9]

template<typename Scalar_T>
class glucat::numeric_traits< Scalar_T >