MetricAdjacency.h

#pragma once

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

#define MetricAdjacency_RECURSES

#if !defined MetricAdjacency_h

#define MetricAdjacency_h

// Inclusions
#include <iostream>
#include <set>
#include <map>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CSpace.h"
#include "DGtal/kernel/SpaceND.h"
#include "DGtal/kernel/BasicPointPredicates.h"

namespace DGtal
{

  // template class MetricAdjacency
  template <typename TSpace, Dimension maxNorm1, 
      Dimension dimension = TSpace::dimension >
  class MetricAdjacency
  {
    BOOST_CONCEPT_ASSERT(( CSpace<TSpace> ));
    // ----------------------- public types ------------------------------
  public:
    // Required by CAdjacency
    typedef TSpace Space;
    typedef typename Space::Point Point;
    typedef MetricAdjacency<Space, maxNorm1, dimension> Adjacency;

    // Others
    typedef typename Space::Vector Vector;
    
    // Required by CUndirectedSimpleLocalGraph
    typedef Point Vertex;
    typedef typename Space::Size Size;
    typedef std::set<Vertex> VertexSet; // DigitalSet doesn't fit since MetricAdjacency has no domain
    template <typename Value> struct VertexMap {
      typedef typename std::map<Vertex, Value> Type;
    };

    // ----------------------- Standard services ------------------------------
  public:

    MetricAdjacency();

    ~MetricAdjacency();

    // ----------------------- Adjacency services -----------------------------
  public:

    static
    bool isAdjacentTo( const Point & p1, const Point & p2 ); 

    static
    bool isProperlyAdjacentTo( const Point & p1, const Point & p2 ); 

    
    // ----------------------- Local graph services --------------------------
    
    static
    Size bestCapacity();
    
    static
    Size degree( const Vertex & v );
    
    template <typename OutputIterator>
    static
    void  
    writeNeighbors( OutputIterator &it ,
                    const Vertex & v );
    
    template <typename OutputIterator, typename VertexPredicate>
    static
    void
    writeNeighbors( OutputIterator &it ,
                    const Vertex & v,
                    const VertexPredicate & pred);
    
    // ----------------------- Interface --------------------------------------
  public:

    static
    void selfDisplay ( std::ostream & out );

    static
    bool isValid();

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
    
    // ------------------------- Hidden services ------------------------------
  protected:
    static Size computeCapacity();

  private:

    MetricAdjacency ( const MetricAdjacency & other );

    MetricAdjacency & operator= ( const MetricAdjacency & other );

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

  }; // end of class MetricAdjacency

  template <typename TSpace, Dimension maxNorm1>
  std::ostream&
  operator<< ( std::ostream & out, 
         const MetricAdjacency< TSpace,maxNorm1,
         TSpace::dimension > & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/topology/MetricAdjacency.ih"

//                                                                           //

#endif // !defined MetricAdjacency_h

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