Struct stack_graphs::partial::PartialPaths

pub struct PartialPaths { /* private fields */ }

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

Implementations

impl PartialPaths

pub fn find_minimal_partial_path_set_in_file<F>( &mut self, graph: &StackGraph, file: Handle<File>, cancellation_flag: &dyn CancellationFlag, visit: F ) -> Result<(), CancellationError>where F: FnMut(&StackGraph, &mut PartialPaths, PartialPath),

Finds a minimal set of partial paths in a file, calling the visit closure for each one.

This function ensures that the set of visited partial paths (a) is minimal, no path can be constructed by stitching other paths in the set, and (b) covers all complete paths, from references to definitions, when used for path stitching

This function will not return until all reachable partial 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 PartialPath::extend manually.

Caveat: Edges between nodes of different files are not used. Hence the returned set of partial paths will not cover paths going through those edges.

pub fn find_all_complete_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 PartialPaths, PartialPath),

Finds all complete 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 PartialPaths

pub fn new() -> PartialPaths