Struct petgraph::visit::Dfs [] [src]

pub struct Dfs<N, VM> {
    pub stack: Vec<N>,
    pub discovered: VM,
}

Visit nodes of a graph in a depth-first-search (DFS) emitting nodes in preorder (when they are first discovered).

The traversal starts at a given node and only traverses nodes reachable from it.

Dfs is not recursive.

Dfs does not itself borrow the graph, and because of this you can run a traversal over a graph while still retaining mutable access to it, if you use it like the following example:

use petgraph::Graph;
use petgraph::visit::Dfs;

let mut graph = Graph::<_,()>::new();
let a = graph.add_node(0);

let mut dfs = Dfs::new(&graph, a);
while let Some(nx) = dfs.next(&graph) {
    // we can access `graph` mutably here still
    graph[nx] += 1;
}

assert_eq!(graph[a], 1);

Note: The algorithm may not behave correctly if nodes are removed during iteration. It may not necessarily visit added nodes or edges.

Fields

The stack of nodes to visit

The map of discovered nodes

Methods

impl<N, VM> Dfs<N, VM> where
    N: Copy + PartialEq,
    VM: VisitMap<N>, 
[src]

[src]

Create a new Dfs, using the graph's visitor map, and put start in the stack of nodes to visit.

[src]

Create a Dfs from a vector and a visit map

[src]

Clear the visit state

[src]

Create a new Dfs using the graph's visitor map, and no stack.

[src]

Keep the discovered map, but clear the visit stack and restart the dfs from a particular node.

[src]

Return the next node in the dfs, or None if the traversal is done.

Trait Implementations

impl<N: Clone, VM: Clone> Clone for Dfs<N, VM>
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl<N: Debug, VM: Debug> Debug for Dfs<N, VM>
[src]

[src]

Formats the value using the given formatter. Read more

impl<G> Walker<G> for Dfs<G::NodeId, G::Map> where
    G: IntoNeighbors + Visitable
[src]

[src]

Advance to the next item

Important traits for WalkerIter<W, C>
[src]

Create an iterator out of the walker and given context.