std::numeric_limits< Mezzanine::Quaternion > Class Template Reference

Get Numeric details on Quaternion. More...

#include <quaternion.h>

Static Public Member Functions
static Mezzanine::Quaternion	denorm_min ()
	Get the closest value to 0 that is not 0 this can represent, including extra precision for being close to 0 if supported. More...
static Mezzanine::Quaternion	epsilon ()
	The smallest value representable from 1.0,1.0,1.0 to the next value. More...
static Mezzanine::Quaternion	infinity ()
	Get the special value "Positive infinity". More...
static Mezzanine::Quaternion	max ()
	Get the highest positive finite value this can represent. More...
static Mezzanine::Quaternion	min ()
	Get the lowest positive finite value this can represent. More...
static Mezzanine::Quaternion	quiet_NaN ()
	Get the special value "Quiet Not actual Number". More...
static Mezzanine::Quaternion	round_error ()
	Get the largest possible rounding error. More...
static Mezzanine::Quaternion	signaling_NaN ()
	Get the special value "Signaling Not actual Number". More...

Static Public Attributes
static const int	digits = std::numeric_limits<Mezzanine::Real>::digits
	How many integer digits(in machine base) of precision can this handle in each X, Y or Z without floating point component or error?
static const int	digits10 = std::numeric_limits<Mezzanine::Real>::digits10
	How many integer digits in base 10 of precision can this handle in each X, Y or Z without floating point component or error?
static const std::float_denorm_style	has_denorm = std::numeric_limits<Mezzanine::Real>::has_denorm
	Does this support exceptionally small numbers near 0?
static const bool	has_denorm_loss = std::numeric_limits<Mezzanine::Real>::has_denorm_loss
	When extra precision near 0 is lost, can this type distinguish that from other imprecision.
static const bool	has_infinity = std::numeric_limits<Mezzanine::Real>::has_infinity
	Can This represent an infinitely large value in X, Y or Z?
static const bool	has_quiet_NaN = std::numeric_limits<Mezzanine::Real>::has_quiet_NaN
	??? Required by std::numeric to be compliant More...
static const bool	has_signaling_NaN = std::numeric_limits<Mezzanine::Real>::has_signaling_NaN
	??? Required by std::numeric to be compliant More...
static const bool	is_exact = std::numeric_limits<Mezzanine::Real>::is_exact
	The Quaternion uses Real, which is typically a machine dependedant which can be inexact.
static const bool	is_iec559 = std::numeric_limits<Mezzanine::Real>::is_iec559
	Do X, Y and Z adhere to iec 559?
static const bool	is_integer = false
	Can this only store integer types.
static const bool	is_modulo = std::numeric_limits<Mezzanine::Real>::is_modulo
	Is overflow of this type handle by modulo overflow?
static const bool	is_signed = true
	Does this support negative values?
static const bool	is_specialized = true
	Does this class (numeric_limits<Mezzanine::Quaternion>) exist.
static const int	max_exponent = std::numeric_limits<Mezzanine::Real>::max_exponent
	The largest power of the radix that is valid floating point value.
static const int	max_exponent10 = std::numeric_limits<Mezzanine::Real>::max_exponent10
	The largest power of 10 that is valid floating point value.
static const int	min_exponent = std::numeric_limits<Mezzanine::Real>::min_exponent
	The smallest power of the radix that is valid floating point value.
static const int	min_exponent10 = std::numeric_limits<Mezzanine::Real>::min_exponent10
	The smallest power of 10 that is valid floating point value.
static const int	radix = std::numeric_limits<Mezzanine::Real>::radix
	The base of the number system that this is implemented in.
static const std::float_round_style	round_style = std::numeric_limits<Mezzanine::Real>::round_style
	How items that fit between the precise amount a Real can represent will be adapted.
static const bool	tinyness_before = std::numeric_limits<Mezzanine::Real>::tinyness_before
	Are tiny values respected during rounding?
static const bool	traps = std::numeric_limits<Mezzanine::Real>::traps
	Can this generate a trap?

Detailed Description

template<>
class std::numeric_limits< Mezzanine::Quaternion >

Get Numeric details on Quaternion.

Definition at line 491 of file quaternion.h.

Member Function Documentation

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::denorm_min ( )

inlinestatic

Get the closest value to 0 that is not 0 this can represent, including extra precision for being close to 0 if supported.

Returns

A vector containing 3 very small values.

Definition at line 618 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::epsilon ( )

inlinestatic

The smallest value representable from 1.0,1.0,1.0 to the next value.

Returns

A Quaternion with very small numbers

Definition at line 563 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::infinity ( )

inlinestatic

Get the special value "Positive infinity".

Returns

A Quaternion containing 4 values.

Definition at line 585 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::max ( )

inlinestatic

Get the highest positive finite value this can represent.

Returns

A Quaternion with 4 very large numbers

Definition at line 552 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::min ( )

inlinestatic

Get the lowest positive finite value this can represent.

Returns

A Quaternion with 4 very small numbers

Definition at line 541 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::quiet_NaN ( )

inlinestatic

Get the special value "Quiet Not actual Number".

Returns

A Quaternion containing 4 values.

Definition at line 596 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::round_error ( )

inlinestatic

Get the largest possible rounding error.

Returns

A Quaternion containing 4 values indicating how much they could be rounded.

Definition at line 574 of file quaternion.h.

static Mezzanine::Quaternion std::numeric_limits< Mezzanine::Quaternion >::signaling_NaN ( )

inlinestatic

Get the special value "Signaling Not actual Number".

Returns

A Quaternion containing 4 special values.

Definition at line 607 of file quaternion.h.

Member Data Documentation

const bool std::numeric_limits< Mezzanine::Quaternion >::has_quiet_NaN = std::numeric_limits<Mezzanine::Real>::has_quiet_NaN

static

??? Required by std::numeric to be compliant

Todo:

Learn why this exists and document it.

Definition at line 506 of file quaternion.h.

const bool std::numeric_limits< Mezzanine::Quaternion >::has_signaling_NaN = std::numeric_limits<Mezzanine::Real>::has_signaling_NaN

static

??? Required by std::numeric to be compliant

Todo:

Learn why this exists and document it.

Definition at line 509 of file quaternion.h.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/quaternion.h