Struct petgraph::visit::Topo

source ·
pub struct Topo<N, VM> { /* private fields */ }
Expand description

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§

source§

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

source

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.

source

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.

source

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.

source

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§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

§

type Item = <G as GraphBase>::NodeId

source§

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

Advance to the next item
source§

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

Create an iterator out of the walker and given context.

Auto Trait Implementations§

§

impl<N, VM> Freeze for Topo<N, VM>
where VM: Freeze,

§

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

§

impl<N, VM> Send for Topo<N, VM>
where VM: Send, N: Send,

§

impl<N, VM> Sync for Topo<N, VM>
where VM: Sync, N: Sync,

§

impl<N, VM> Unpin for Topo<N, VM>
where VM: Unpin, N: Unpin,

§

impl<N, VM> UnwindSafe for Topo<N, VM>
where VM: UnwindSafe, N: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.