DGtal::concepts::CIntegralNumber< T > Struct Template Reference

Aim: Concept checking for Integral Numbers. Models of this concept should be listed in NumberTraits class and should have the isIntegral property. More...

#include <DGtal/kernel/CIntegralNumber.h>

Inheritance diagram for DGtal::concepts::CIntegralNumber< T >:

Public Member Functions
	BOOST_CONCEPT_USAGE (CIntegralNumber)

Private Attributes
NumberTraits< T >::IsIntegral	myIsIntegral

Detailed Description

template<typename T>
struct DGtal::concepts::CIntegralNumber< T >

Aim: Concept checking for Integral Numbers. Models of this concept should be listed in NumberTraits class and should have the isIntegral property.

Description of concept 'CIntegralNumber'

Refinement of

• CQuantity<T>

Associated types

Notation

• X : A type that is a model of CIntegralNumber
• x, y : Object of type X

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Postcondition	Complexity
X should be tagged true in NumberTraits for IsIntegral.	typename NumberTraits<X>::IsIntegral	TagTrue

Invariants

Models

BigInteger, short, int, long long, uint32_t, int16_t, int32_t, int64_t, ...

Notes

Template Parameters

T	the type that is checked. T should be a model of CBoundedInteger.

Definition at line 101 of file CIntegralNumber.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

DGtal::concepts::CIntegralNumber< T >::BOOST_CONCEPT_USAGE ( CIntegralNumber< T >  )

inline

Definition at line 105 of file CIntegralNumber.h.

    {
      // Will compile iff Integral.
      ConceptUtils::checkTrue( myIsIntegral );
    }

References DGtal::concepts::ConceptUtils::checkTrue(), and DGtal::concepts::CIntegralNumber< T >::myIsIntegral.

Field Documentation

myIsIntegral

template<typename T >

NumberTraits<T>::IsIntegral DGtal::concepts::CIntegralNumber< T >::myIsIntegral

private

Definition at line 113 of file CIntegralNumber.h.

Referenced by DGtal::concepts::CIntegralNumber< T >::BOOST_CONCEPT_USAGE().

---

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

• CIntegralNumber.h