Struct stack_graphs::paths::Paths

pub struct Paths { /* private fields */ }

Manages the state of a collection of paths built up as part of the path-finding algorithm.

Implementations

impl Paths

pub fn find_all_paths<I, F>(
    &mut self,
    graph: &StackGraph,
    starting_nodes: I,
    cancellation_flag: &dyn CancellationFlag,
    visit: F
) -> Result<(), CancellationError>where
    I: IntoIterator<Item = Handle<Node>>,
    F: FnMut(&StackGraph, &mut Paths, Path),

Finds all paths reachable from a set of starting nodes, calling the visit closure for each one.

This function will not return until all reachable paths have been processed, so graph must already contain a complete stack graph. If you have a very large stack graph stored in some other storage system, and want more control over lazily loading only the necessary pieces, then you should code up your own loop that calls Path::extend manually.

impl Paths

pub fn remove_shadowed_paths(
    &mut self,
    paths: &mut Vec<Path>,
    cancellation_flag: &dyn CancellationFlag
) -> Result<(), CancellationError>

Removes any paths that are shadowed by any other path, according to the precedence values of the edges in the paths.

impl Paths

pub fn new() -> Paths