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
INVALIDif the stack is empty.
-
inline bool emptyQueue() const
Returns
falseif there are nodes to be processed.Returns
falseif 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
tfrom 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
awitham[a]true is found.- Parameters:
am – A
bool(or convertible) arc map. The algorithm will stop when it reaches an arcawitham[a]true.- Returns:
The reached arc
awitham[a]true orINVALIDif 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
sin 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
sandt.This method runs the DFS algorithm from node
sin order to compute the DFS path to nodet(it stops searching whentis 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:
trueiftis reachable forms.
-
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
tshould be reached from the root(s).
-
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
vis not reached from the root(s), then the return value of this function is undefined.
-
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 tov. It isINVALIDifvis not reached from the root(s) or ifvis a root.The DFS tree used here is equal to the DFS tree used in predNode() and predMap().
-
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 tov. It isINVALIDifvis not reached from the root(s) or ifvis a root.The DFS tree used here is equal to the DFS tree used in predArc() and predMap().
-
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.
Public Types
-
typedef TR::ProcessedMap ProcessedMap
The type of the map that indicates which nodes are processed.
-
typedef TR Traits
The traits class of the algorithm.
Public Functions
-
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 SetPredMap : public Dfs< Digraph , SetPredMapTraits< T > > Named parameter for setting
PredMaptype. Named parameter for settingPredMaptype. It must conform to the WriteMap concept.Public Types
-
typedef Dfs< Digraph , SetPredMapTraits< T > > Create
-
typedef Dfs< Digraph , SetPredMapTraits< T > > Create
-
template< class T >
struct SetDistMap : public Dfs< Digraph , SetDistMapTraits< T > > Named parameter for setting
DistMaptype. Named parameter for settingDistMaptype. It must conform to the WriteMap concept.Public Types
-
typedef Dfs< Digraph , SetDistMapTraits< T > > Create
-
typedef Dfs< Digraph , SetDistMapTraits< T > > Create
-
template< class T >
struct SetReachedMapTraits : public Traits -
Public Static Functions
-
static inline ReachedMap * createReachedMap( const Digraph & )
-
static inline ReachedMap * createReachedMap( const Digraph & )
-
template< class T >
struct SetReachedMap : public Dfs< Digraph , SetReachedMapTraits< T > > Named parameter for setting
ReachedMaptype. Named parameter for settingReachedMaptype. It must conform to the ReadWriteMap concept.Public Types
-
typedef Dfs< Digraph , SetReachedMapTraits< T > > Create
-
typedef Dfs< Digraph , SetReachedMapTraits< T > > Create
-
template< class T >
struct SetProcessedMapTraits : public Traits -
Public Static Functions
-
static inline ProcessedMap * createProcessedMap( const Digraph & )
-
static inline ProcessedMap * createProcessedMap( const Digraph & )
-
template< class T >
struct SetProcessedMap : public Dfs< Digraph , SetProcessedMapTraits< T > > Named parameter for setting
ProcessedMaptype. Named parameter for settingProcessedMaptype. It must conform to the WriteMap concept.Public Types
-
typedef Dfs< Digraph , SetProcessedMapTraits< T > > Create
-
typedef Dfs< Digraph , SetProcessedMapTraits< T > > Create
-
struct SetStandardProcessedMapTraits : public Traits
-
Public Static Functions
-
static inline ProcessedMap * createProcessedMap( const Digraph & g )
-
static inline ProcessedMap * createProcessedMap( const Digraph & g )
-
struct SetStandardProcessedMap : public Dfs< Digraph , SetStandardProcessedMapTraits >
Named parameter for setting
ProcessedMaptype to beDigraph::NodeMap< bool >. Named parameter for settingProcessedMaptype to beDigraph::NodeMap< bool >. If you don’t set it explicitly, it will be automatically allocated.Public Types
-
typedef Dfs< Digraph , SetStandardProcessedMapTraits > Create
-
typedef Dfs< Digraph , SetStandardProcessedMapTraits > Create