DomainAdjacency.h

#pragma once

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

#define DomainAdjacency_RECURSES

#if !defined DomainAdjacency_h

#define DomainAdjacency_h

// Inclusions
#include <iostream>
#include <map>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/domains/CDomain.h"
#include "DGtal/kernel/domains/DomainPredicate.h"
#include "DGtal/topology/CAdjacency.h"
#include "DGtal/kernel/sets/DigitalSetSelector.h"

namespace DGtal
{

  // template class DomainAdjacency
  template <typename TDomain, typename TAdjacency>
  class DomainAdjacency
  {
    BOOST_CONCEPT_ASSERT(( CDomain<TDomain> ));
    BOOST_CONCEPT_ASSERT(( CAdjacency<TAdjacency> ));
  public:

    // Required as model of CAdjacency
    typedef typename TDomain::Space Space; 
    typedef TAdjacency Adjacency;
    typedef typename TDomain::Point Point;

    // Required as model of CDomainAdjacency
    typedef TDomain Domain;
    typedef DomainPredicate< Domain > Predicate;

    // Required by CUndirectedSimpleLocalGraph
    typedef Point Vertex;
    typedef typename Space::Size Size;
    typedef typename DigitalSetSelector< Domain,
      SMALL_DS + HIGH_ITER_DS >::Type VertexSet;
    template <typename Value> struct VertexMap {
      typedef typename std::map<Vertex, Value> Type;
    };
    
    // ----------------------- Standard services ------------------------------
  public:
    
    DomainAdjacency( const Domain & aDomain, const Adjacency & adjacency );

    DomainAdjacency( const DomainAdjacency & other );

    ~DomainAdjacency();

    const Domain & domain() const;

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

    const Predicate & predicate() const;

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

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

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

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

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
    Predicate myPred;

    const Adjacency & myAdjacency;

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

    DomainAdjacency();

  private:

    DomainAdjacency & operator= ( const DomainAdjacency & other );

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

  }; // end of class DomainAdjacency


  template <typename TDomain, typename TAdjacency>
  std::ostream&
  operator<< ( std::ostream & out, 
         const DomainAdjacency<TDomain, TAdjacency> & object );

} // namespace DGtal


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

//                                                                           //

#endif // !defined DomainAdjacency_h

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