Enum EventPred

pub enum EventPred {
    Init {
        root: usize,
    },
    Previsit {
        node: usize,
        pred: usize,
        root: usize,
        depth: usize,
    },
    Revisit {
        node: usize,
        pred: usize,
        root: usize,
        depth: usize,
        on_stack: bool,
    },
    Postvisit {
        node: usize,
        pred: usize,
        root: usize,
        depth: usize,
    },
    Done {
        root: usize,
    },
}

Types of callback events generated during depth-first visits keeping track of parent nodes (and possibly of the visit path).

Variants

Init

This event should be used to set up state at the start of the visit.

Note that this event will not happen if the visit is empty, that is, all of the roots are already visited or filtered.

Fields

root: usize

The root of the current visit tree, that is, the first node that will be visited.

Previsit

The node has been encountered for the first time: we are traversing a new tree arc, unless all node fields are equal to the root.

Fields

node: usize

The current node.

pred: usize

The parent of node in the visit tree.

root: usize

The root of the current visit tree.

depth: usize

The depth of the visit, that is, the length of the visit path from the root to node.

Revisit

The node has been encountered before: we are traversing a back arc, a forward arc, or a cross arc.

Fields

node: usize

The current node.

pred: usize

The parent of node in the visit tree.

root: usize

The root of the current visit tree.

depth: usize

The depth of the visit, that is, the length of the visit path from the root to curr.

on_stack: bool

Whether the node is currently on the visit path, that is, if we are traversing a back arc, and retreating from it. This might be always false if the visit does not keep track of the visit path.

Postvisit

The enumeration of the successors of the node has been completed: we are retreating from a tree arc, unless all node fields are equal to the root.

Fields

node: usize

The current node.

pred: usize

The parent of curr in the visit tree.

root: usize

The root of the current visit tree.

depth: usize

The depth of the visit, that is, the length of the visit path from the root to node.

Done

The visit has been completed.

Note that this event will not happen if the visit is empty (that is, if the root has already been visited) or if the visit is stopped by a callback returning an error.

Fields

root: usize

The root of the current visit tree.

Trait Implementations

impl Clone for EventPred

fn clone(&self) -> EventPred

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventPred

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

Formats the value using the given formatter.

impl Event for EventPred

type FilterArgs = FilterArgsPred

The type passed as input to the filter.

impl Hash for EventPred

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventPred

fn eq(&self, other: &EventPred) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: NodeStates, G: RandomAccessGraph> Sequential<EventPred> for SeqIter<'_, S, G, usize, true>

fn visit_filtered_with<R: IntoIterator<Item = usize>, T, E, C: FnMut(&mut T, EventPred) -> ControlFlow<E, ()>, F: FnMut(&mut T, FilterArgsPred) -> bool>( &mut self, roots: R, init: T, callback: C, filter: F, ) -> ControlFlow<E, ()>

Visits the graph from the specified nodes with an initialization value and a filter function.

fn reset(&mut self)

Resets the visit status, making it possible to reuse it.

fn visit_filtered<R: IntoIterator<Item = usize>, E, C: FnMut(A) -> ControlFlow<E, ()>, F: FnMut(A::FilterArgs) -> bool>( &mut self, roots: R, callback: C, filter: F, ) -> ControlFlow<E, ()>

Visits the graph from the specified nodes with a filter function.

fn visit_with<R: IntoIterator<Item = usize>, T, E, C: FnMut(&mut T, A) -> ControlFlow<E, ()>>( &mut self, roots: R, init: T, callback: C, ) -> ControlFlow<E, ()>

Visits the graph from the specified nodes with an initialization value.

fn visit<R: IntoIterator<Item = usize>, E, C: FnMut(A) -> ControlFlow<E, ()>>( &mut self, roots: R, callback: C, ) -> ControlFlow<E, ()>

Visits the graph from the specified nodes.

impl Eq for EventPred

impl StructuralPartialEq for EventPred