Public Member Functions | Private Attributes

DGtal::CInteger< T > Struct Template Reference
[DGtal concepts]

Aim: The concept CInteger specifies what are the usual integer numbers, more precisely the ones that are representable on a computer. More...

#include <CInteger.h>

Inheritance diagram for DGtal::CInteger< T >:
Inheritance graph
[legend]

Public Member Functions

 BOOST_CONCEPT_USAGE (CInteger)

Private Attributes

myX
myY
IntegerTraits< T >::IsUnsigned myIsUnsigned
IntegerTraits< T >::IsBounded myIsBounded
IntegerTraits< T >::SignedVersion mySignedVersion
IntegerTraits< T >::UnsignedVersion myUnsignedVersion
IntegerTraits< T >::ReturnType myReturnType

Detailed Description

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

Aim: The concept CInteger specifies what are the usual integer numbers, more precisely the ones that are representable on a computer.

Description of concept 'CInteger'

Generally, all the basic computer integer types are models of this concept. More elaborate integer types with variable sizes, for instance the big integers of GMP, are also models of this concept.

Refinement of boost::Assignable<T>, boost::EqualityComparable<T>

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
Construction from basic integer type X( i ) X represents the integer i
Addition x+y X addition of two integers

Invariants

Models

short, int, unsigned int, long long, unsigned long long, uint16_t, uint32_t, uint64_t, int16_t, int32_t, int64_t.

Notes

Todo:
Complete integer checking.

Member Function Documentation

template<typename T >
DGtal::CInteger< T >::BOOST_CONCEPT_USAGE ( CInteger< T >   )  [inline]

Field Documentation

template<typename T >
IntegerTraits<T>::IsBounded DGtal::CInteger< T >::myIsBounded [private]
template<typename T >
IntegerTraits<T>::IsUnsigned DGtal::CInteger< T >::myIsUnsigned [private]

Reimplemented in DGtal::CUnsignedInteger< T >.

template<typename T >
IntegerTraits<T>::ReturnType DGtal::CInteger< T >::myReturnType [private]
template<typename T >
IntegerTraits<T>::SignedVersion DGtal::CInteger< T >::mySignedVersion [private]
template<typename T >
IntegerTraits<T>::UnsignedVersion DGtal::CInteger< T >::myUnsignedVersion [private]
template<typename T >
T DGtal::CInteger< T >::myX [private]
template<typename T >
T DGtal::CInteger< T >::myY [private]

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