CUndirectedSimpleLocalGraph.h

#pragma once

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

#define CUndirectedSimpleLocalGraph_RECURSES

#if !defined CUndirectedSimpleLocalGraph_h

#define CUndirectedSimpleLocalGraph_h

// Inclusions
#include <iostream>
#include <boost/concept_archetype.hpp>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CInteger.h"
#include "DGtal/topology/CVertexMap.h"

namespace DGtal
{

  // class CUndirectedSimpleLocalGraph
  template <typename T> 
  struct CUndirectedSimpleLocalGraph 
  // Use derivation for coarser concepts, like
  // : CoarserConcept<T>
  // Think to boost::CopyConstructible<T>, boost::DefaultConstructible<T>, ...
  // http://www.boost.org/doc/libs/1_49_0/libs/concept_check/reference.htm
  {
    // ----------------------- Concept checks ------------------------------
  public:
    // 1. define first provided types (i.e. inner types), like
    typedef typename T::Vertex Vertex;
    typedef typename T::Size Size;
    typedef typename T::VertexSet VertexSet;
    template <typename Value> struct VertexMap {
      typedef typename T::template VertexMap<Value>::Type Type;
      BOOST_CONCEPT_ASSERT(( CVertexMap< VertexMap<Value> > ));
    };
 
    // possibly check these types so as to satisfy a concept with
    BOOST_CONCEPT_ASSERT(( CInteger< Size > ));

    // 2. then check the presence of data members, operators and methods with
    BOOST_CONCEPT_USAGE( CUndirectedSimpleLocalGraph )
    {
      // check const methods.
      checkConstConstraints();
    }
    void checkConstConstraints() const
    {
      ConceptUtils::sameType( mySize, myX.bestCapacity() );
      ConceptUtils::sameType( mySize, myX.degree( myVertex ) );
      myX.writeNeighbors( myOutIt, myVertex );
      // @todo create VertexPredicate to test the other writeNeighbors method.
    }

    // ------------------------- Private Datas --------------------------------
  private:
    T myX; // do not require T to be default constructible.
    Size mySize;
    Vertex myVertex;
    mutable boost::output_iterator_archetype<Vertex> myOutIt;
    
    // ------------------------- Internals ------------------------------------
  private:
    
  }; // end of concept CUndirectedSimpleLocalGraph
  
} // namespace DGtal

//                                                                           //

#endif // !defined CUndirectedSimpleLocalGraph_h

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