DGtal  1.5.beta
DGtal::concepts::CBoundedNumber< T > Struct Template Reference

Aim: The concept CBoundedNumber specifies what are the bounded numbers. Models of this concept should be listed in NumberTraits class and should have the isBounded property. More...

#include <DGtal/kernel/CBoundedNumber.h>

Inheritance diagram for DGtal::concepts::CBoundedNumber< T >:
[legend]

Public Member Functions

 BOOST_CONCEPT_USAGE (CBoundedNumber)
 

Private Attributes

myX
 
NumberTraits< T >::IsBounded myIsBounded
 

Detailed Description

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

Aim: The concept CBoundedNumber specifies what are the bounded numbers. Models of this concept should be listed in NumberTraits class and should have the isBounded property.

Description of concept 'CBoundedNumber'

Refinement of

  • CQuantity<T>

Associated types:

Notation

Definitions

Valid expressions and semantics

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
Tthe type that is checked. T should be a model of CBoundedNumber.

Definition at line 96 of file CBoundedNumber.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CBoundedNumber< T >::BOOST_CONCEPT_USAGE ( CBoundedNumber< T >  )
inline

Definition at line 100 of file CBoundedNumber.h.

101  {
102 
103  // Bounded Number should have a TagTrue tag to IsBounded type.
105 
106  }
void checkTrue(const TagTrue &tag)
NumberTraits< T >::IsBounded myIsBounded

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

Field Documentation

◆ myIsBounded

template<typename T >
NumberTraits<T>::IsBounded DGtal::concepts::CBoundedNumber< T >::myIsBounded
private

◆ myX

template<typename T >
T DGtal::concepts::CBoundedNumber< T >::myX
private

Definition at line 110 of file CBoundedNumber.h.


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