#include <CInteger.h>

Inheritance diagram for DGtal::CInteger< T >:

Collaboration diagram for DGtal::CInteger< T >:

Public Member Functions
	BOOST_CONCEPT_USAGE (CInteger)

Private Member Functions
	BOOST_STATIC_ASSERT ((ConceptUtils::CheckTrueOrFalse< typename NumberTraits< T >::IsUnsigned >::value))
	BOOST_STATIC_ASSERT ((ConceptUtils::CheckTrueOrFalse< typename NumberTraits< T >::IsSigned >::value))
	BOOST_STATIC_ASSERT ((ConceptUtils::CheckTrueOrFalse< typename NumberTraits< T >::IsBounded >::value))

Private Attributes
T	myX
NumberTraits< T >::IsUnsigned	myIsUnsigned
NumberTraits< T >::IsSigned	myIsSigned
NumberTraits< T >::IsBounded	myIsBounded
NumberTraits< T >::SignedVersion	mySignedVersion
NumberTraits< T >::UnsignedVersion	myUnsignedVersion
NumberTraits< 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>, boost::LessThanComparable<T>

Associated types :

Notation

X : A type that is a model of CInteger
x, y : object of type X
i, j : basic integer type.

Definitions

Valid expressions and semantics

<table>
<tr>
<td class=CName> \b Name </td>
<td class=CExpression> \b Expression </td>
<td class=CRequirements> \b Type requirements </td>
<td class=CReturnType> \b Return type </td>
<td class=CPrecondition> \b Precondition </td>
<td class=CSemantics> \b Semantics </td>
<td class=CPostCondition> \b Postcondition </td>
<td class=CComplexity> \b Complexity </td>
</tr>
<tr>
<td class=CName>            Construction from basic integer type </td>
<td class=CExpression>      X( i ) </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       \t X represents the integer \t i</td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Addition </td>
<td class=CExpression>      \t x + \t y </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       addition of two integers </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Subtraction </td>
<td class=CExpression>      \t x - \t y </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       subtraction of two integers </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Multiplication </td>
<td class=CExpression>      \t x * \t y </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       multiplication of two integers </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Division </td>
<td class=CExpression>      \t x / \t y </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       euclidean division of two integers </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Modulo </td>
<td class=CExpression>      \t x % \t y </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       modulo of two integers </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Pre-increment </td>
<td class=CExpression>      ++ \t x </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       \t x is incremented then its value is returned  </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            Pre-decrement </td>
<td class=CExpression>      &ndash; \t x </td>
<td class=CRequirements>    </td>
<td class=CReturnType>      \t X</td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       \t x is decremented then its value is returned  </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should have constant \t ZERO  in \t NumberTraits. </td>
<td class=CExpression>      NumberTraits<X>::ZERO </td>
<td class=CRequirements>    constant should be defined </td>
<td class=CReturnType>      const \t X </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       the value 0</td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should have constant \t ONE in \t NumberTraits. </td>
<td class=CExpression>      NumberTraits<X>::ONE </td>
<td class=CRequirements>    constant should be defined </td>
<td class=CReturnType>      const \t X </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       the value 1</td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>            \t X should be tagged in \t NumberTraits for \t IsUnsigned. </td>
<td class=CExpression>      typename NumberTraits<X>::IsUnsigned </td>
<td class=CRequirements>    TagTrue or TagFalse </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should be tagged in \t NumberTraits for \t IsSigned. </td>
<td class=CExpression>      typename NumberTraits<X>::IsSigned </td>
<td class=CRequirements>    TagTrue or TagFalse </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should be tagged in \t NumberTraits for \t IsBounded. </td>
<td class=CExpression>      typename NumberTraits<X>::IsBounded </td>
<td class=CRequirements>    TagTrue or TagFalse </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should have type \t SignedVersion  in \t NumberTraits. </td>
<td class=CExpression>      typename NumberTraits<X>::SignedVersion </td>
<td class=CRequirements>    type must be defined </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should have type \t UnsignedVersion  in \t NumberTraits. </td>
<td class=CExpression>      typename NumberTraits<X>::UnsignedVersion </td>
<td class=CRequirements>    type must be defined </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>
<tr>
<td class=CName>             \t X should have type \t ReturnType  in \t NumberTraits. </td>
<td class=CExpression>      typename NumberTraits<X>::ReturnType </td>
<td class=CRequirements>    type must be defined </td>
<td class=CReturnType>      </td>
<td class=CPrecondition>    </td>
<td class=CSemantics>       </td>
<td class=CPostCondition>   </td>
<td class=CComplexity>      </td>
</tr>

</table>

Invariants

Models

short, int, unsigned int, long long, unsigned long long,
uint16_t, uint32_t, uint64_t, int16_t, int32_t, int64_t,
DGtal::BigInteger

Notes

Template Parameters:

T	the type that should be a model of integer.

Definition at line 269 of file CInteger.h.

Member Function Documentation

template<typename T >

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

inline

Definition at line 273 of file CInteger.h.

References DGtal::CInteger< T >::myX, and DGtal::ConceptUtils::sameType().

    {
      T x( 0 ); // require constructor from built-in integer.
      T y( 1 ); // require constructor from built-in integer.
      ConceptUtils::sameType( myX, ++x );
      ConceptUtils::sameType( myX, --x );
      ConceptUtils::sameType( myX, NumberTraits<T>::ZERO );
      ConceptUtils::sameType( myX, NumberTraits<T>::ONE );
      // @note x-y with short is promoted to int. We should use some
      // verification with possible promoting.
      //
      // @note T(x-y) is required (instead of 'x-y') because of
      // gmpxx. Indeed, x+y returns an expression template in GMP and
      // thus cannot be of type T.
      ConceptUtils::sameType( myX, T(x-y) );
      // @note x+y with short is promoted to int. We should use some
      // verification with possible promoting.
      //
      // @note T(x+y) is required (instead of 'x+y') because of
      // gmpxx. Indeed, x+y returns an expression template in GMP and
      // thus cannot be of type T.
      ConceptUtils::sameType( myX, T(x+y) );
      ConceptUtils::sameType( myX, T(x*y) );
      ConceptUtils::sameType( myX, T(x/y) );
      ConceptUtils::sameType( myX, T(x%y) );
    }

template<typename T >

DGtal::CInteger< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::CheckTrueOrFalse< typename NumberTraits< T >::IsUnsigned >::value) )

private

template<typename T >

DGtal::CInteger< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::CheckTrueOrFalse< typename NumberTraits< T >::IsSigned >::value) )

private

template<typename T >

DGtal::CInteger< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::CheckTrueOrFalse< typename NumberTraits< T >::IsBounded >::value) )

private

Field Documentation

template<typename T >

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

private

Reimplemented in DGtal::CBoundedInteger< T >.

Definition at line 306 of file CInteger.h.

template<typename T >

NumberTraits<T>::IsSigned DGtal::CInteger< T >::myIsSigned

private

Reimplemented in DGtal::CSignedInteger< T >.

Definition at line 305 of file CInteger.h.

template<typename T >

NumberTraits<T>::IsUnsigned DGtal::CInteger< T >::myIsUnsigned

private

Reimplemented in DGtal::CUnsignedInteger< T >.

Definition at line 304 of file CInteger.h.

template<typename T >

NumberTraits<T>::ReturnType DGtal::CInteger< T >::myReturnType

private

Definition at line 309 of file CInteger.h.

template<typename T >

NumberTraits<T>::SignedVersion DGtal::CInteger< T >::mySignedVersion

private

Definition at line 307 of file CInteger.h.

template<typename T >

NumberTraits<T>::UnsignedVersion DGtal::CInteger< T >::myUnsignedVersion

private

Definition at line 308 of file CInteger.h.

template<typename T >

T DGtal::CInteger< T >::myX

private

Reimplemented in DGtal::CBoundedInteger< T >.

Definition at line 303 of file CInteger.h.

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

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

CInteger.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Refinement of boost::Assignable<T>,

Associated types :

Notation

Definitions

Valid expressions and semantics

Invariants

Models

Notes

Member Function Documentation

Field Documentation

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