NumberTraits common part for fundamental integer and floating-point types. More...

#include <DGtal/kernel/NumberTraits.h>

Inheritance diagram for DGtal::details::NumberTraitsImplFundamental< T >:

Public Types
using	IsBounded = typename BoolToTag<NL::is_bounded>::type
	Is the number bounded.
using	IsUnsigned = typename BoolToTag<!NL::is_signed>::type
	Is the number unsigned.
using	IsSigned = typename BoolToTag<NL::is_signed>::type
	Is the number signed.
using	IsIntegral = typename BoolToTag<NL::is_integer>::type
	Is the number of integral type.
using	IsSpecialized = TagTrue
	Is that a number type with specific traits.
using	ReturnType = T
	Alias to the type that should be used as return type.
using	ParamType = typename boost::call_traits<T>::param_type
	Defines a type that represents the "best" way to pass a parameter of type T to a function.

Static Public Member Functions
static constexpr ReturnType	zero () noexcept
	Return the zero of this integer.
static constexpr ReturnType	one () noexcept
	Return the one of this integer.
static constexpr ReturnType	min () noexcept
	Return the minimum possible value for this type of number.
static constexpr ReturnType	max () noexcept
	Return the maximum possible value for this type of number.
static constexpr unsigned int	digits () noexcept
	Return the number of significant binary digits for this type of number.
static constexpr BoundEnum	isBounded () noexcept
	Return the bounding type of the number.
static constexpr SignEnum	isSigned () noexcept
	Return the sign type of the number.
static constexpr DGtal::int64_t	castToInt64_t (const T &aT) noexcept
	Cast method to DGtal::int64_t (for I/O or board export uses only).
static constexpr DGtal::uint64_t	castToUInt64_t (const T &aT) noexcept
	Cast method to DGtal::uint64_t (for I/O or board export uses only).
static constexpr double	castToDouble (const T &aT) noexcept
	Cast method to double (for I/O or board export uses only).
static constexpr bool	even (ParamType aT) noexcept
	Check the parity of a number.
static constexpr bool	odd (ParamType aT) noexcept
	Check the parity of a number.

Static Public Attributes
static constexpr T	ZERO = T(0)
	Constant Zero.
static constexpr T	ONE = T(1)
	Constant One.

Private Types
using	NL = std::numeric_limits<T>
	Type alias to std::numeric_limits.

Detailed Description

template<typename T>
struct DGtal::details::NumberTraitsImplFundamental< T >

NumberTraits common part for fundamental integer and floating-point types.

Definition at line 213 of file NumberTraits.h.

Member Typedef Documentation

◆ IsBounded

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::IsBounded = typename BoolToTag<NL::is_bounded>::type

Is the number bounded.

Definition at line 220 of file NumberTraits.h.

◆ IsIntegral

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::IsIntegral = typename BoolToTag<NL::is_integer>::type

Is the number of integral type.

Definition at line 223 of file NumberTraits.h.

◆ IsSigned

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::IsSigned = typename BoolToTag<NL::is_signed>::type

Is the number signed.

Definition at line 222 of file NumberTraits.h.

◆ IsSpecialized

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::IsSpecialized = TagTrue

Is that a number type with specific traits.

Definition at line 224 of file NumberTraits.h.

◆ IsUnsigned

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::IsUnsigned = typename BoolToTag<!NL::is_signed>::type

Is the number unsigned.

Definition at line 221 of file NumberTraits.h.

◆ NL

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::NL = std::numeric_limits<T>

private

Type alias to std::numeric_limits.

Definition at line 216 of file NumberTraits.h.

◆ ParamType

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::ParamType = typename boost::call_traits<T>::param_type

Defines a type that represents the "best" way to pass a parameter of type T to a function.

Definition at line 231 of file NumberTraits.h.

◆ ReturnType

template<typename T>

using DGtal::details::NumberTraitsImplFundamental< T >::ReturnType = T

Alias to the type that should be used as return type.

Definition at line 226 of file NumberTraits.h.

Member Function Documentation

◆ castToDouble()

template<typename T>

constexpr double DGtal::details::NumberTraitsImplFundamental< T >::castToDouble ( const T & aT )

inlinestaticconstexprnoexcept

Cast method to double (for I/O or board export uses only).

Definition at line 319 of file NumberTraits.h.

      {
        return static_cast<double>(aT);
      }

◆ castToInt64_t()

template<typename T>

constexpr DGtal::int64_t DGtal::details::NumberTraitsImplFundamental< T >::castToInt64_t ( const T & aT )

inlinestaticconstexprnoexcept

Cast method to DGtal::int64_t (for I/O or board export uses only).

Definition at line 299 of file NumberTraits.h.

      {
        return static_cast<DGtal::int64_t>(aT);
      }

◆ castToUInt64_t()

template<typename T>

constexpr DGtal::uint64_t DGtal::details::NumberTraitsImplFundamental< T >::castToUInt64_t ( const T & aT )

inlinestaticconstexprnoexcept

Cast method to DGtal::uint64_t (for I/O or board export uses only).

Definition at line 309 of file NumberTraits.h.

      {
        return static_cast<DGtal::uint64_t>(aT);
      }

◆ digits()

template<typename T>

constexpr unsigned int DGtal::details::NumberTraitsImplFundamental< T >::digits ( )

inlinestaticconstexprnoexcept

Return the number of significant binary digits for this type of number.

Definition at line 269 of file NumberTraits.h.

      {
        return static_cast<unsigned int>(NL::digits);
      }

◆ even()

template<typename T>

constexpr bool DGtal::details::NumberTraitsImplFundamental< T >::even ( ParamType aT )

inlinestaticconstexprnoexcept

Check the parity of a number.

Parameters

aT	any number.

Returns: 'true' iff the number is even.

Definition at line 330 of file NumberTraits.h.

      {
        return ( aT & ONE ) == ZERO;
      }

References ONE, and ZERO.

◆ isBounded()

template<typename T>

constexpr BoundEnum DGtal::details::NumberTraitsImplFundamental< T >::isBounded ( )

inlinestaticconstexprnoexcept

Return the bounding type of the number.

Returns: BOUNDED, UNBOUNDED, or BOUND_UNKNOWN.

Definition at line 279 of file NumberTraits.h.

      {
        return NL::is_bounded ? BOUNDED : UNBOUNDED;
      }

References DGtal::BOUNDED, and DGtal::UNBOUNDED.

◆ isSigned()

template<typename T>

constexpr SignEnum DGtal::details::NumberTraitsImplFundamental< T >::isSigned ( )

inlinestaticconstexprnoexcept

Return the sign type of the number.

Returns: SIGNED, UNSIGNED or SIGN_UNKNOWN.

Definition at line 289 of file NumberTraits.h.

      {
        return NL::is_signed ? SIGNED : UNSIGNED;
      }

References DGtal::SIGNED, and DGtal::UNSIGNED.

◆ max()

template<typename T>

constexpr ReturnType DGtal::details::NumberTraitsImplFundamental< T >::max ( )

inlinestaticconstexprnoexcept

Return the maximum possible value for this type of number.

Definition at line 262 of file NumberTraits.h.

      {
        return NL::max();
      }

◆ min()

template<typename T>

constexpr ReturnType DGtal::details::NumberTraitsImplFundamental< T >::min ( )

inlinestaticconstexprnoexcept

Return the minimum possible value for this type of number.

Definition at line 255 of file NumberTraits.h.

      {
        return NL::min();
      }

◆ odd()

template<typename T>

constexpr bool DGtal::details::NumberTraitsImplFundamental< T >::odd ( ParamType aT )

inlinestaticconstexprnoexcept

Check the parity of a number.

Parameters

aT	any number.

Returns: 'true' iff the number is odd.

Definition at line 341 of file NumberTraits.h.

      {
        return ( aT & ONE ) != ZERO;
      }

References ONE, and ZERO.

◆ one()

template<typename T>

constexpr ReturnType DGtal::details::NumberTraitsImplFundamental< T >::one ( )

inlinestaticconstexprnoexcept

Return the one of this integer.

Definition at line 248 of file NumberTraits.h.

      {
        return ONE;
      }

References ONE.

◆ zero()

template<typename T>

constexpr ReturnType DGtal::details::NumberTraitsImplFundamental< T >::zero ( )

inlinestaticconstexprnoexcept

Return the zero of this integer.

Definition at line 241 of file NumberTraits.h.

      {
        return ZERO;
      }

References ZERO.

Field Documentation

◆ ONE

template<typename T>

T DGtal::details::NumberTraitsImplFundamental< T >::ONE = T(1)

staticconstexpr

Constant One.

Definition at line 237 of file NumberTraits.h.

Referenced by even(), odd(), and one().

◆ ZERO

template<typename T>

T DGtal::details::NumberTraitsImplFundamental< T >::ZERO = T(0)

staticconstexpr

Constant Zero.

Definition at line 234 of file NumberTraits.h.

Referenced by even(), odd(), and zero().

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

NumberTraits.h

Public Types

Static Public Member Functions

Static Public Attributes

Private Types

Detailed Description

Member Typedef Documentation

◆ IsBounded

◆ IsIntegral

◆ IsSigned

◆ IsSpecialized

◆ IsUnsigned

◆ NL

◆ ParamType

◆ ReturnType

Member Function Documentation

◆ castToDouble()

◆ castToInt64_t()

◆ castToUInt64_t()

◆ digits()

◆ even()

◆ isBounded()

◆ isSigned()

◆ max()

◆ min()

◆ odd()

◆ one()

◆ zero()

Field Documentation

◆ ONE

◆ ZERO