Struct petgraph::visit::Topo

pub struct Topo<N, VM> { /* private fields */ }

A topological order traversal for a graph.

Note that Topo only visits nodes that are not part of cycles, i.e. nodes in a true DAG. Use other visitors like DfsPostOrder or algorithms like kosaraju_scc to handle graphs with possible cycles.

Implementations

impl<N, VM> Topo<N, VM>

where N: Copy + PartialEq, VM: VisitMap<N>,

pub fn new<G>(graph: G) -> Self

where G: IntoNodeIdentifiers + IntoNeighborsDirected + Visitable<NodeId = N, Map = VM>,

Create a new Topo, using the graph’s visitor map, and put all initial nodes in the to visit list.

pub fn with_initials<G, I>(graph: G, initials: I) -> Self

where G: IntoNeighborsDirected + Visitable<NodeId = N, Map = VM>, I: IntoIterator<Item = N>,

Create a new Topo with initial nodes.

Nodes with incoming edges are ignored.

pub fn reset<G>(&mut self, graph: G)

where G: IntoNodeIdentifiers + IntoNeighborsDirected + Visitable<NodeId = N, Map = VM>,

Clear visited state, and put all initial nodes in the to visit list.

pub fn next<G>(&mut self, g: G) -> Option<N>

where G: IntoNeighborsDirected + Visitable<NodeId = N, Map = VM>,

Return the next node in the current topological order traversal, or None if the traversal is at the end.

Note: The graph may not have a complete topological order, and the only way to know is to run the whole traversal and make sure it visits every node.

Trait Implementations

impl<N: Clone, VM: Clone> Clone for Topo<N, VM>

fn clone(&self) -> Topo<N, VM>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N, VM> Default for Topo<N, VM>

where VM: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<G> Walker<G> for Topo<G::NodeId, G::Map>

where G: IntoNeighborsDirected + Visitable,

type Item = <G as GraphBase>::NodeId

fn walk_next(&mut self, context: G) -> Option<Self::Item>

Advance to the next item

fn iter(self, context: Context) -> WalkerIter<Self, Context>

where Self: Sized, Context: Clone,

Create an iterator out of the walker and given context.