Struct petgraph::algo::TarjanScc

source ·
pub struct TarjanScc<N> { /* private fields */ }
Expand description

A reusable state for computing the strongly connected components using Tarjan’s algorithm.

Implementations§

source§

impl<N> TarjanScc<N>

source

pub fn new() -> Self

Creates a new TarjanScc

source

pub fn run<G, F>(&mut self, g: G, f: F)
where G: IntoNodeIdentifiers<NodeId = N> + IntoNeighbors<NodeId = N> + NodeIndexable<NodeId = N>, F: FnMut(&[N]), N: Copy + PartialEq,

[Generic] Compute the strongly connected components using Algorithm 3 in A Space-Efficient Algorithm for Finding Strongly Connected Components by David J. Pierce, which is a memory-efficient variation of Tarjan’s algorithm.

Calls f for each strongly strongly connected component (scc). The order of node ids within each scc is arbitrary, but the order of the sccs is their postorder (reverse topological sort).

For an undirected graph, the sccs are simply the connected components.

This implementation is recursive and does one pass over the nodes.

source

pub fn node_component_index<G>(&self, g: G, v: N) -> usize
where G: IntoNeighbors<NodeId = N> + NodeIndexable<NodeId = N>, N: Copy + PartialEq,

Returns the index of the component in which v has been assigned. Allows for using self as a lookup table for an scc decomposition produced by self.run().

Trait Implementations§

source§

impl<N: Debug> Debug for TarjanScc<N>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<N> Default for TarjanScc<N>

source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<N> Freeze for TarjanScc<N>

§

impl<N> RefUnwindSafe for TarjanScc<N>
where N: RefUnwindSafe,

§

impl<N> Send for TarjanScc<N>
where N: Send,

§

impl<N> Sync for TarjanScc<N>
where N: Sync,

§

impl<N> Unpin for TarjanScc<N>
where N: Unpin,

§

impl<N> UnwindSafe for TarjanScc<N>
where 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> 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, 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.