DGtal::CBoundedInteger< T > Struct Template Reference

#include <CBoundedInteger.h>

Inheritance diagram for DGtal::CBoundedInteger< T >:

Collaboration diagram for DGtal::CBoundedInteger< T >:

Public Member Functions
	BOOST_CONCEPT_USAGE (CBoundedInteger)
Public Member Functions inherited from DGtal::CInteger< T >
	BOOST_CONCEPT_USAGE (CInteger)

Private Attributes
T	myX
NumberTraits< T >::IsBounded	myIsBounded

---

Detailed Description

template<typename T>
struct DGtal::CBoundedInteger< T >

Aim: The concept CBoundedInteger specifies what are the bounded integer numbers. Hence, it is a refinement of CInteger Concept ensuring that the numbers are bounded.

DescriptionDescription of concept 'CBoundedInteger'

Refinement of CInteger<T>

Associated types :

Notation

• X : A type that is a model of CBoundedInteger

Definitions

Valid expressions and

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

Invariants

Models

short, int, unsigned int, long long, unsigned long long,
uint16_t, uint32_t, uint64_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 110 of file CBoundedInteger.h.

---

Member Function Documentation

template<typename T >

DGtal::CBoundedInteger< T >::BOOST_CONCEPT_USAGE ( CBoundedInteger< T >  )

inline

Definition at line 114 of file CBoundedInteger.h.

References DGtal::ConceptUtils::checkTrue(), and DGtal::CBoundedInteger< T >::myIsBounded.

    {

      // Bounded Integer should have a TagTrue tag to IsBounded type.
      ConceptUtils::checkTrue( myIsBounded );

    }

---

Field Documentation

template<typename T >

NumberTraits<T>::IsBounded DGtal::CBoundedInteger< T >::myIsBounded

private

Reimplemented from DGtal::CInteger< T >.

Definition at line 125 of file CBoundedInteger.h.

Referenced by DGtal::CBoundedInteger< T >::BOOST_CONCEPT_USAGE().

template<typename T >

T DGtal::CBoundedInteger< T >::myX

private

Reimplemented from DGtal::CInteger< T >.

Definition at line 124 of file CBoundedInteger.h.

---

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

• CBoundedInteger.h