DepthFirstVisitor.h

#pragma once

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

#define DepthFirstVisitor_RECURSES

#if !defined DepthFirstVisitor_h

#define DepthFirstVisitor_h

// Inclusions
#include <iostream>
#include <stack>
#include "DGtal/base/Common.h"
#include "DGtal/base/CountedPtr.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/kernel/sets/DigitalSetSelector.h"
#include "DGtal/kernel/sets/DigitalSetDomain.h"
#include "DGtal/topology/DomainAdjacency.h"
#include "DGtal/graph/CUndirectedSimpleLocalGraph.h"

namespace DGtal
{

  // template class DepthFirstVisitor
  template < typename TGraph, 
             typename TMarkSet = typename TGraph::VertexSet >
  class DepthFirstVisitor
  {
    // ----------------------- Associated types ------------------------------
  public:
    typedef DepthFirstVisitor<TGraph,TMarkSet> Self;
    typedef TGraph Graph;
    typedef TMarkSet MarkSet;
    typedef typename Graph::Size Size;
    typedef typename Graph::Vertex Vertex;
    typedef Size Data; 

    //BOOST_CONCEPT_ASSERT(( CUndirectedSimpleLocalGraph< Graph > ));
    // Cannot check this since some types using it are incomplete.
    //BOOST_CONCEPT_ASSERT(( CSet< MarkSet, Vertex > ));

    // ----------------------- defined types ------------------------------
  public:

    typedef std::pair< Vertex, Data > Node;
    typedef std::stack< Node > NodeQueue;
    typedef std::vector< Vertex > VertexList;


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

    ~DepthFirstVisitor();

    DepthFirstVisitor ( const DepthFirstVisitor & other );

    DepthFirstVisitor( ConstAlias<Graph> graph );

    DepthFirstVisitor( ConstAlias<Graph> graph, const Vertex & p );

    template <typename VertexIterator>
    DepthFirstVisitor( ConstAlias<Graph> graph, 
                         VertexIterator b, VertexIterator e );


    const Graph & graph() const;

    // ----------------------- traversal services ------------------------------
  public:

    const Node & current() const; 

    void ignore();

    void expand();

    template <typename VertexPredicate>
    void expand( const VertexPredicate & authorized_vtx );
    
    bool finished() const;

    void terminate();

    const MarkSet & markedVertices() const;

    MarkSet visitedVertices() const;


    // ----------------------- Interface --------------------------------------
  public:

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

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:

    const Graph & myGraph;

    MarkSet myMarkedVertices;

    NodeQueue myQueue;

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

    DepthFirstVisitor();

  private:

    DepthFirstVisitor & operator= ( const DepthFirstVisitor & other );

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

  }; // end of class DepthFirstVisitor


  template <typename TGraph, typename TMarkSet >
  std::ostream&
  operator<< ( std::ostream & out, 
               const DepthFirstVisitor<TGraph, TMarkSet > & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/graph/DepthFirstVisitor.ih"

//                                                                           //

#endif // !defined DepthFirstVisitor_h

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