Dfs

Declared in lemon/dfs.h, in the group Graph Search; the same class on the Doxygen site.

template< typename GR , typename TR >
class Dfs

DFS algorithm class.

This class provides an efficient implementation of the DFS algorithm.

There is also a function-type interface for the DFS algorithm, which is convenient in the simplier cases and it can be used easier.

Template Parameters:
  • GR – The type of the digraph the algorithm runs on. The default type is ListDigraph.

  • TR – The traits class that defines various types used by the algorithm. By default, it is DfsDefaultTraits< GR >. In most cases, this parameter should not be set directly, consider to use the named template parameters instead.

Execution Control

The simplest way to execute the DFS algorithm is to use one of the member functions called run()

.

If you need better control on the execution, you have to call

inline void init()

Initializes the internal data structures.

init() first, then you can add a source node with addSource() and perform the actual computation with start(). This procedure can be repeated if there are nodes that have not been reached.

Initializes the internal data structures.

inline void addSource( Node s )

Adds a new source node.

Adds a new source node to the set of nodes to be processed.

Pre:

The stack must be empty. Otherwise the algorithm gives wrong results. (One of the outgoing arcs of all the source nodes except for the last one will not be visited and distances will also be wrong.)

inline Arc processNextArc()

Processes the next arc.

Returns:

The processed arc.

Pre:

The stack must not be empty.

inline OutArcIt nextArc() const

Next arc to be processed.

Returns:

The next arc to be processed or INVALID if the stack is empty.

inline bool emptyQueue() const

Returns false if there are nodes to be processed.

Returns false if there are nodes to be processed in the queue (stack).

inline int queueSize() const

Returns the number of the nodes to be processed.

Returns the number of the nodes to be processed in the queue (stack).

inline void start()

Executes the algorithm.

This method runs the DFS algorithm from the root node in order to compute the DFS path to each node.

The algorithm computes

  • the DFS tree,

  • the distance of each node from the root in the DFS tree.

Note

d.start() is just a shortcut of the following code.

while( ! d.emptyQueue() ) {
 d.processNextArc();
 }

Pre:

init() must be called and a root node should be added with addSource() before using this function.

inline void start( Node t )

Executes the algorithm until the given target node is reached.

This method runs the DFS algorithm from the root node in order to compute the DFS path to t.

The algorithm computes

  • the DFS path to t,

  • the distance of t from the root in the DFS tree.

Pre:

init() must be called and a root node should be added with addSource() before using this function.

template< class ArcBoolMap >
inline Arc start( const ArcBoolMap & am )

Executes the algorithm until a condition is met.

This method runs the DFS algorithm from the root node until an arc a with am[a] true is found.

Warning

Contrary to Bfs and Dijkstra, am is an arc map, not a node map.

Parameters:

am – A bool (or convertible) arc map. The algorithm will stop when it reaches an arc a with am[a] true.

Returns:

The reached arc a with am[a] true or INVALID if no such arc was found.

Pre:

init() must be called and a root node should be added with addSource() before using this function.

inline void run( Node s )

Runs the algorithm from the given source node.

This method runs the DFS algorithm from node s in order to compute the DFS path to each node.

The algorithm computes

  • the DFS tree,

  • the distance of each node from the root in the DFS tree.

Note

d.run(s) is just a shortcut of the following code.

d.init();
d.addSource( s );
d.start();

inline bool run( Node s , Node t )

Finds the DFS path between s and t.

This method runs the DFS algorithm from node s in order to compute the DFS path to node t (it stops searching when t is reached)

Note

Apart from the return value, d.run(s,t) is just a shortcut of the following code.

d.init();
d.addSource( s );
d.start( t );

Returns:

true if t is reachable form s.

inline void run()

Runs the algorithm to visit all nodes in the digraph.

This method runs the DFS algorithm in order to visit all nodes in the digraph.

Note

d.run() is just a shortcut of the following code.

d.init();
for( NodeIt n( digraph ) ; n != INVALID ; ++n )
{
 if( ! d.reached( n ) ) {
  d.addSource( n );
  d.start();
  }
 }

Query Functions

The results of the DFS algorithm can be obtained using these functions.

Either

run() or start() should be called before using them.

inline Path path( Node t ) const

The DFS path to the given node.

Returns the DFS path to the given node from the root(s).

Warning

t should be reached from the root(s).

Pre:

Either run() or init() must be called before using this function.

inline int dist( Node v ) const

The distance of the given node from the root(s).

Returns the distance of the given node from the root(s).

Warning

If node v is not reached from the root(s), then the return value of this function is undefined.

Pre:

Either run() or init() must be called before using this function.

inline Arc predArc( Node v ) const

Returns the ‘previous arc’ of the DFS tree for the given node.

This function returns the ‘previous arc’ of the DFS tree for the node v, i.e. it returns the last arc of a DFS path from a root to v. It is INVALID if v is not reached from the root(s) or if v is a root.

The DFS tree used here is equal to the DFS tree used in predNode() and predMap().

Pre:

Either run() or init() must be called before using this function.

inline Node predNode( Node v ) const

Returns the ‘previous node’ of the DFS tree for the given node.

This function returns the ‘previous node’ of the DFS tree for the node v, i.e. it returns the last but one node of a DFS path from a root to v. It is INVALID if v is not reached from the root(s) or if v is a root.

The DFS tree used here is equal to the DFS tree used in predArc() and predMap().

Pre:

Either run() or init() must be called before using this function.

inline const DistMap & distMap() const

Returns a const reference to the node map that stores the distances of the nodes.

Returns a const reference to the node map that stores the distances of the nodes calculated by the algorithm.

Pre:

Either run() or init() must be called before using this function.

inline const PredMap & predMap() const

Returns a const reference to the node map that stores the predecessor arcs.

Returns a const reference to the node map that stores the predecessor arcs, which form the DFS tree (forest).

Pre:

Either run() or init() must be called before using this function.

inline bool reached( Node v ) const

Checks if the given node. node is reached from the root(s).

Returns true if v is reached from the root(s).

Pre:

Either run() or init() must be called before using this function.

Public Types

typedef TR::Digraph Digraph

The type of the digraph the algorithm runs on.

typedef TR::PredMap PredMap

The type of the map that stores the predecessor arcs of the DFS paths.

typedef TR::DistMap DistMap

The type of the map that stores the distances of the nodes.

typedef TR::ReachedMap ReachedMap

The type of the map that indicates which nodes are reached.

typedef TR::ProcessedMap ProcessedMap

The type of the map that indicates which nodes are processed.

typedef PredMapPath< Digraph , PredMap > Path

The type of the paths.

typedef TR Traits

The traits class of the algorithm.

typedef Dfs Create

Public Functions

inline Dfs( const Digraph & g )

Constructor.

Parameters:

g – The digraph the algorithm runs on.

inline ~Dfs()

Destructor.

inline Dfs & predMap( PredMap & m )

Sets the map that stores the predecessor arcs. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

inline Dfs & reachedMap( ReachedMap & m )

Sets the map that indicates which nodes are reached. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

inline Dfs & processedMap( ProcessedMap & m )

Sets the map that indicates which nodes are processed. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

inline Dfs & distMap( DistMap & m )

Sets the map that stores the distances of the nodes.

Sets the map that stores the distances of the nodes calculated by the algorithm. If you don’t use this function before calling run() or init(), an instance will be allocated automatically. The destructor deallocates this automatically allocated map, of course.

Returns:

(*this)

Protected Functions

inline Dfs()
template< class T >
struct SetPredMapTraits : public Traits

Public Types

typedef T PredMap

Public Static Functions

static inline PredMap * createPredMap( const Digraph & )
template< class T >
struct SetPredMap : public Dfs< Digraph , SetPredMapTraits< T > >

Named parameter for setting

PredMap type. Named parameter for setting PredMap type. It must conform to the WriteMap concept.

Public Types

typedef Dfs< Digraph , SetPredMapTraits< T > > Create
template< class T >
struct SetDistMapTraits : public Traits

Public Types

typedef T DistMap

Public Static Functions

static inline DistMap * createDistMap( const Digraph & )
template< class T >
struct SetDistMap : public Dfs< Digraph , SetDistMapTraits< T > >

Named parameter for setting

DistMap type. Named parameter for setting DistMap type. It must conform to the WriteMap concept.

Public Types

typedef Dfs< Digraph , SetDistMapTraits< T > > Create
template< class T >
struct SetReachedMapTraits : public Traits

Public Types

typedef T ReachedMap

Public Static Functions

static inline ReachedMap * createReachedMap( const Digraph & )
template< class T >
struct SetReachedMap : public Dfs< Digraph , SetReachedMapTraits< T > >

Named parameter for setting

ReachedMap type. Named parameter for setting ReachedMap type. It must conform to the ReadWriteMap concept.

Public Types

typedef Dfs< Digraph , SetReachedMapTraits< T > > Create
template< class T >
struct SetProcessedMapTraits : public Traits

Public Types

typedef T ProcessedMap

Public Static Functions

static inline ProcessedMap * createProcessedMap( const Digraph & )
template< class T >
struct SetProcessedMap : public Dfs< Digraph , SetProcessedMapTraits< T > >

Named parameter for setting

ProcessedMap type. Named parameter for setting ProcessedMap type. It must conform to the WriteMap concept.

Public Types

typedef Dfs< Digraph , SetProcessedMapTraits< T > > Create
struct SetStandardProcessedMapTraits : public Traits

Public Types

typedef Digraph::template NodeMap< bool > ProcessedMap

Public Static Functions

static inline ProcessedMap * createProcessedMap( const Digraph & g )
struct SetStandardProcessedMap : public Dfs< Digraph , SetStandardProcessedMapTraits >

Named parameter for setting

ProcessedMap type to be Digraph::NodeMap< bool >. Named parameter for setting ProcessedMap type to be Digraph::NodeMap< bool >. If you don’t set it explicitly, it will be automatically allocated.

Public Types

typedef Dfs< Digraph , SetStandardProcessedMapTraits > Create