Aim: The traits class for all models of Cinteger (implementation) More...

#include <DGtal/kernel/NumberTraits.h>

Inheritance diagram for DGtal::NumberTraitsImpl< T, Enable >:

Public Types
typedef TagUnknown	IsBounded
	Is the number bounded.

typedef TagUnknown	IsUnsigned
	Is the number unsigned.

typedef TagUnknown	IsSigned
	Is the number signed.

typedef TagUnknown	IsIntegral
	Is the number of integral type.

typedef TagFalse	IsSpecialized
	Is that a number type with specific traits.

typedef T	SignedVersion
	Alias to the signed version of the number type.

typedef T	UnsignedVersion
	Alias to the unsigned version of the number type.

typedef T	ReturnType
	Alias to the type that should be used as return type.

typedef boost::call_traits< T >::param_type	ParamType
	Defines a type that represents the "best" way to pass a parameter of type T to a function.

Static Public Member Functions
static ReturnType	zero ()
	Return the zero of this integer.

static ReturnType	one ()
	Return the one of this integer.

static ReturnType	min ()
	Return the minimum possible value for this type of integer or ONE if not bounded or unknown.

static ReturnType	max ()
	Return the maximum possible value for this type of integer or ZERO if not bounded or unknown.

static unsigned int	digits ()
	Return the number of significant binary digits for this integer type, or 0 if unbounded or unknown.

static BoundEnum	isBounded ()
	Return the bounding type of the number.

static SignEnum	isSigned ()
	Return the sign type of the number.

static DGtal::int64_t	castToInt64_t (const T &aT)
	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 double	castToDouble (const T &aT)
	Cast method to double (for I/O or board export uses only).

static bool	even (ParamType aT)
	Check the parity of a number.

static bool	odd (ParamType aT)
	Check the parity of a number.

Static Public Attributes
static const T	ZERO = T(0)
	Constant Zero.

static const T	ONE = T(1)
	Constant One.

Detailed Description

template<typename T, typename Enable = void>
struct DGtal::NumberTraitsImpl< T, Enable >

Aim: The traits class for all models of Cinteger (implementation)

Description of template class 'NumberTraitsImpl'

Since CInteger describes the concept Integer, this class is used by models of CIinteger to specialize some definitions related to Integer. For instance it defines whether a given Integer is signed or not and what is signed/unsigned version.

This is the fallback declaration for unknown types (IsSpecialized points to TagFalse).

Template Parameters

T	Number type.
Enable	Internal template parameter used for SFINAE.

See also: NumberTraits

Definition at line 81 of file NumberTraits.h.

Member Typedef Documentation

◆ IsBounded

template<typename T , typename Enable = void>

typedef TagUnknown DGtal::NumberTraitsImpl< T, Enable >::IsBounded

Is the number bounded.

Definition at line 84 of file NumberTraits.h.

◆ IsIntegral

template<typename T , typename Enable = void>

typedef TagUnknown DGtal::NumberTraitsImpl< T, Enable >::IsIntegral

Is the number of integral type.

Definition at line 87 of file NumberTraits.h.

◆ IsSigned

template<typename T , typename Enable = void>

typedef TagUnknown DGtal::NumberTraitsImpl< T, Enable >::IsSigned

Is the number signed.

Definition at line 86 of file NumberTraits.h.

◆ IsSpecialized

template<typename T , typename Enable = void>

typedef TagFalse DGtal::NumberTraitsImpl< T, Enable >::IsSpecialized

Is that a number type with specific traits.

Definition at line 88 of file NumberTraits.h.

◆ IsUnsigned

template<typename T , typename Enable = void>

typedef TagUnknown DGtal::NumberTraitsImpl< T, Enable >::IsUnsigned

Is the number unsigned.

Definition at line 85 of file NumberTraits.h.

◆ ParamType

template<typename T , typename Enable = void>

typedef boost::call_traits<T>::param_type DGtal::NumberTraitsImpl< T, Enable >::ParamType

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

Definition at line 96 of file NumberTraits.h.

◆ ReturnType

template<typename T , typename Enable = void>

typedef T DGtal::NumberTraitsImpl< T, Enable >::ReturnType

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

Definition at line 91 of file NumberTraits.h.

◆ SignedVersion

template<typename T , typename Enable = void>

typedef T DGtal::NumberTraitsImpl< T, Enable >::SignedVersion

Alias to the signed version of the number type.

Definition at line 89 of file NumberTraits.h.

◆ UnsignedVersion

template<typename T , typename Enable = void>

typedef T DGtal::NumberTraitsImpl< T, Enable >::UnsignedVersion

Alias to the unsigned version of the number type.

Definition at line 90 of file NumberTraits.h.

Member Function Documentation

◆ castToDouble()

template<typename T , typename Enable = void>

static double DGtal::NumberTraitsImpl< T, Enable >::castToDouble ( const T & aT )

inlinestatic

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

Definition at line 164 of file NumberTraits.h.

    {
      return static_cast<double>(aT);
    }

◆ castToInt64_t()

template<typename T , typename Enable = void>

static DGtal::int64_t DGtal::NumberTraitsImpl< T, Enable >::castToInt64_t ( const T & aT )

inlinestatic

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

Definition at line 145 of file NumberTraits.h.

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

◆ castToUInt64_t()

template<typename T , typename Enable = void>

static constexpr DGtal::uint64_t DGtal::NumberTraitsImpl< T, Enable >::castToUInt64_t ( const T & aT )

inlinestaticconstexprnoexcept

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

Definition at line 155 of file NumberTraits.h.

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

◆ digits()

template<typename T , typename Enable = void>

static unsigned int DGtal::NumberTraitsImpl< T, Enable >::digits ( )

static

Return the number of significant binary digits for this integer type, or 0 if unbounded or unknown.

◆ even()

template<typename T , typename Enable = void>

static bool DGtal::NumberTraitsImpl< T, Enable >::even ( ParamType aT )

inlinestatic

Check the parity of a number.

Parameters

aT	any number.

Returns: 'true' iff the number is even.

Definition at line 173 of file NumberTraits.h.

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

References DGtal::NumberTraitsImpl< T, Enable >::ONE, and DGtal::NumberTraitsImpl< T, Enable >::ZERO.

◆ isBounded()

template<typename T , typename Enable = void>

static BoundEnum DGtal::NumberTraitsImpl< T, Enable >::isBounded ( )

static

Return the bounding type of the number.

Returns: BOUNDED, UNBOUNDED, or BOUND_UNKNOWN.

◆ isSigned()

template<typename T , typename Enable = void>

static SignEnum DGtal::NumberTraitsImpl< T, Enable >::isSigned ( )

static

Return the sign type of the number.

Returns: SIGNED, UNSIGNED or SIGN_UNKNOWN.

◆ max()

template<typename T , typename Enable = void>

static ReturnType DGtal::NumberTraitsImpl< T, Enable >::max ( )

static

Return the maximum possible value for this type of integer or ZERO if not bounded or unknown.

◆ min()

template<typename T , typename Enable = void>

static ReturnType DGtal::NumberTraitsImpl< T, Enable >::min ( )

static

Return the minimum possible value for this type of integer or ONE if not bounded or unknown.

◆ odd()

template<typename T , typename Enable = void>

static bool DGtal::NumberTraitsImpl< T, Enable >::odd ( ParamType aT )

inlinestatic

Check the parity of a number.

Parameters

aT	any number.

Returns: 'true' iff the number is odd.

Definition at line 183 of file NumberTraits.h.

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

References DGtal::NumberTraitsImpl< T, Enable >::ONE, and DGtal::NumberTraitsImpl< T, Enable >::ZERO.

◆ one()

template<typename T , typename Enable = void>

static ReturnType DGtal::NumberTraitsImpl< T, Enable >::one ( )

static

Return the one of this integer.

◆ zero()

template<typename T , typename Enable = void>

static ReturnType DGtal::NumberTraitsImpl< T, Enable >::zero ( )

static

Return the zero of this integer.

Field Documentation

◆ ONE

template<typename T , typename Enable >

const T DGtal::NumberTraitsImpl< T, Enable >::ONE = T(1)

static

Constant One.

Definition at line 103 of file NumberTraits.h.

Referenced by DGtal::NumberTraitsImpl< T, Enable >::even(), DGtal::NumberTraitsImpl< T, Enable >::odd(), and DGtal::NumberTraitsImpl< DGtal::BigInteger, Enable >::one().

◆ ZERO

template<typename T , typename Enable >

const T DGtal::NumberTraitsImpl< T, Enable >::ZERO = T(0)

static

Constant Zero.

Definition at line 100 of file NumberTraits.h.

Referenced by DGtal::NumberTraitsImpl< T, Enable >::even(), DGtal::NumberTraitsImpl< DGtal::BigInteger, Enable >::max(), DGtal::NumberTraitsImpl< DGtal::BigInteger, Enable >::min(), DGtal::NumberTraitsImpl< T, Enable >::odd(), and DGtal::NumberTraitsImpl< DGtal::BigInteger, Enable >::zero().

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

NumberTraits.h

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ IsBounded

◆ IsIntegral

◆ IsSigned

◆ IsSpecialized

◆ IsUnsigned

◆ ParamType

◆ ReturnType

◆ SignedVersion

◆ UnsignedVersion

Member Function Documentation

◆ castToDouble()

◆ castToInt64_t()

◆ castToUInt64_t()

◆ digits()

◆ even()

◆ isBounded()

◆ isSigned()

◆ max()

◆ min()

◆ odd()

◆ one()

◆ zero()

Field Documentation

◆ ONE

◆ ZERO