Morton.h

#pragma once

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

#define Morton_RECURSES

#if !defined Morton_h

#define Morton_h

// Inclusions
#include <iostream>
#include <boost/array.hpp>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/PointVector.h"
#include "DGtal/kernel/CUnsignedInteger.h"
#include "DGtal/kernel/CInteger.h"

#include "DGtal/base/Bits.h"

namespace DGtal
{

  // template class Morton
  template <typename THashKey, typename TPoint >
  class Morton
  {
  public:
    typedef THashKey HashKey;
    typedef TPoint Point;
    typedef typename Point::Coordinate Coordinate;
    static const Dimension dimension = Point::dimension;    

    BOOST_CONCEPT_ASSERT(( CUnsignedInteger<THashKey> ));
    BOOST_CONCEPT_ASSERT(( CInteger<Coordinate> ));

    Morton();
    
    void interleaveBits(const Point  & aPoint, HashKey & output) const;


    HashKey keyFromCoordinates(const std::size_t treeDepth, const Point & coordinates) const;

    void coordinatesFromKey(const HashKey key, Point & coordinates) const;

    inline HashKey parentKey(const HashKey key) const
    {
      return key >> dimension;
    }

    void brotherKeys(const HashKey key, HashKey* result ) const;

    
    void childrenKeys(const HashKey key, HashKey* result ) const;
    
  private: 
    
    //boost::array< HashKey,LOG2<sizeof(HashKey)*8>::VALUE> myDilateMasks;
    //boost::array< HashKey,LOG2<sizeof(HashKey)*8>::VALUE> myContractMasks;
  };
} // namespace DGtal


//                                                                           //
// Includes inline functions
#include "DGtal/images/Morton.ih"

#endif // !defined Morton_h

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