spk::MathUtils::NumericLimitVector3< TScalar > Struct Template Reference

Numeric limits adapter for 3D vector scalar types. More...

#include <spk_math_utils.hpp>

Collaboration diagram for spk::MathUtils::NumericLimitVector3< TScalar >:

Public Types
using	value_type = IVector3<TScalar>
	Vector type using the provided scalar.

Static Public Member Functions
static constexpr value_type	min () noexcept
	Returns the minimum finite value for each component.
static constexpr value_type	max () noexcept
	Returns the maximum finite value for each component.
static constexpr value_type	lowest () noexcept
	Returns the lowest finite value for each component.
static constexpr value_type	epsilon () noexcept
	Returns the machine epsilon for each component.
static constexpr value_type	roundError () noexcept
	Returns the rounding error for each component.

Static Public Attributes
static constexpr bool	is_specialized = true
	Indicates this specialization is provided.
static constexpr int	digits = std::numeric_limits<TScalar>::digits
	Number of radix digits for the scalar type.
static constexpr int	digits10 = std::numeric_limits<TScalar>::digits10
	Number of base-10 digits for the scalar type.
static constexpr int	max_digits10 = std::numeric_limits<TScalar>::max_digits10
	Maximum number of base-10 digits to preserve round-trips.
static constexpr bool	is_signed = std::numeric_limits<TScalar>::is_signed
	true if the scalar type is signed.
static constexpr bool	is_integer = std::numeric_limits<TScalar>::is_integer
	true if the scalar type is integer.
static constexpr bool	is_exact = std::numeric_limits<TScalar>::is_exact
	true if the scalar type is exact.
static constexpr int	radix = std::numeric_limits<TScalar>::radix
	The radix of the scalar type representation.

Detailed Description

template<typename TScalar>
struct spk::MathUtils::NumericLimitVector3< TScalar >

Numeric limits adapter for 3D vector scalar types.

Template Parameters

TScalar

scalar type used by the vector components.

See also

spk::IVector3, std::numeric_limits

auto epsilonValue = spk::MathUtils::NumericLimitVector3<float>::epsilon();

Member Function Documentation

epsilon()

template<typename TScalar>

constexpr value_type spk::MathUtils::NumericLimitVector3< TScalar >::epsilon ( )

inlinestaticconstexprnoexcept

Returns the machine epsilon for each component.

Returns

Vector of epsilon values.

lowest()

template<typename TScalar>

constexpr value_type spk::MathUtils::NumericLimitVector3< TScalar >::lowest ( )

inlinestaticconstexprnoexcept

Returns the lowest finite value for each component.

Returns

Vector with component-wise lowest values.

max()

template<typename TScalar>

constexpr value_type spk::MathUtils::NumericLimitVector3< TScalar >::max ( )

inlinestaticconstexprnoexcept

Returns the maximum finite value for each component.

Returns

Vector with component-wise maximum values.

min()

template<typename TScalar>

constexpr value_type spk::MathUtils::NumericLimitVector3< TScalar >::min ( )

inlinestaticconstexprnoexcept

Returns the minimum finite value for each component.

Returns

Vector with component-wise minimum values.

roundError()

template<typename TScalar>

constexpr value_type spk::MathUtils::NumericLimitVector3< TScalar >::roundError ( )

inlinestaticconstexprnoexcept

Returns the rounding error for each component.

Returns

Vector of rounding error values.

---

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

• includes/utils/spk_math_utils.hpp