ModuloComputer.h

#pragma once

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

#define ModuloComputer_RECURSES

#if !defined ModuloComputer_h

#define ModuloComputer_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/NumberTraits.h"
#include "DGtal/kernel/CInteger.h"

namespace DGtal
{

  // template class ModuloComputer
  template <typename TInteger>
  class ModuloComputer
  {
  public:    
    typedef TInteger Integer;
    typedef typename NumberTraits<Integer>::ParamType IntegerParamType;

    typedef typename NumberTraits<TInteger>::UnsignedVersion UnsignedInteger;
    typedef typename NumberTraits<UnsignedInteger>::ParamType UnsignedIntegerParamType;

    BOOST_CONCEPT_ASSERT((concepts::CInteger<Integer>));
    
    ModuloComputer( UnsignedIntegerParamType m );
    
    void increment( UnsignedInteger & i ) const;

    void decrement( UnsignedInteger  & i ) const;

    UnsignedInteger next( UnsignedIntegerParamType i ) const;

    UnsignedInteger previous( UnsignedIntegerParamType i ) const;

    UnsignedInteger cast( IntegerParamType i ) const;
    
    bool less( UnsignedIntegerParamType i, UnsignedIntegerParamType j ) const;

    UnsignedInteger posDiff( UnsignedIntegerParamType j, UnsignedIntegerParamType i ) const;
    
  public:
    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Private Datas --------------------------------
  private:
    UnsignedInteger k;

    // ------------------------- Hidden services ------------------------------
  protected:

    ModuloComputer();

  private:

    ModuloComputer ( const ModuloComputer & other );

    ModuloComputer & operator= ( const ModuloComputer & other );

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

  }; // end of class ModuloComputer

  template <typename T>
  std::ostream&
  operator<< ( std::ostream & out, 
         const ModuloComputer<T> & object )
  {
    object.selfDisplay( out );
    return out;
  }
  
} // namespace DGtal


// Includes inline functions.
#include "DGtal/arithmetic/ModuloComputer.ih"

//                                                                           //

#endif // !defined ModuloComputer_h

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