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/graph/CVertexMap.h"
#include "DGtal/graph/CVertexPredicate.h"
#include "DGtal/graph/CVertexPredicateArchetype.h"

// @since 0.8 In DGtal::concepts
namespace DGtal { 
  namespace concepts {

    // class CUndirectedSimpleLocalGraph
    template <typename T> 
    struct CUndirectedSimpleLocalGraph 
    {
      // ----------------------- 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(( CIntegralNumber< Size > ));
      BOOST_CONCEPT_ASSERT(( boost::DefaultConstructible< Vertex > ));
      BOOST_CONCEPT_ASSERT(( boost::Assignable< Vertex > ));
      BOOST_CONCEPT_ASSERT(( boost::CopyConstructible< Vertex > ));

      // 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 );
        myX.writeNeighbors( myOutIt, myVertex, myVPred );
      }

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

//                                                                           //

#endif // !defined CUndirectedSimpleLocalGraph_h

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