CInteger.h

#pragma once

#if defined(CInteger_RECURSES)
#error Recursive header files inclusion detected in CInteger.h
#else // defined(CInteger_RECURSES)

#define CInteger_RECURSES

#if !defined CInteger_h

#define CInteger_h

// Inclusions
#include <iostream>
#include "boost/concept_check.hpp"
#include "DGtal/base/ConceptUtils.h"
#include "DGtal/base/Common.h"
#include "DGtal/kernel/NumberTraits.h"

namespace DGtal
{

  // class CInteger
  template <typename T>
  struct CInteger : boost::Assignable<T>, boost::EqualityComparable<T>, boost::LessThanComparable<T>
  {
    // ----------------------- Concept checks ------------------------------
  public:
    BOOST_CONCEPT_USAGE(CInteger)
    {
      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) );
    }

    // ------------------------- Private Datas --------------------------------
  private:
    T myX;
    typename NumberTraits<T>::IsUnsigned myIsUnsigned;
    typename NumberTraits<T>::IsSigned myIsSigned;
    typename NumberTraits<T>::IsBounded myIsBounded;
    typename NumberTraits<T>::SignedVersion mySignedVersion;
    typename NumberTraits<T>::UnsignedVersion myUnsignedVersion;
    typename NumberTraits<T>::ReturnType myReturnType;

    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 ));

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of concept CInteger

} // namespace DGtal

//                                                                           //

#endif // !defined CInteger_h

#undef CInteger_RECURSES
#endif // else defined(CInteger_RECURSES)