Struct DFS 

pub struct DFS<V, D, C>
where
    D: FnMut(V),
    C: FnMut(V),
{ /* private fields */ }

Depth-first search over a finite graph.

Constructed via DFS::new with a builder-style API. The discovered set is persisted internally, allowing multiple calls to traverse with different start vertices while sharing visited-vertex state.

The type parameters D and C are the callback types for on_discover and on_complete, respectively.

Implementations

impl<V> DFS<V, fn(V), fn(V)>

pub fn new() -> Self

Creates a new DFS.

Defaults to outward traversal, an empty discovered set, and no callbacks. Use the builder methods to configure before calling traverse.

impl<V, D, C> DFS<V, D, C>

where D: FnMut(V), C: FnMut(V),

pub fn traversal_direction(self, dir: TraversalDirection) -> Self

Sets the traversal direction (outward or inward along edges). Defaults to TraversalDirection::Outward.

pub fn on_discover<D2: FnMut(V)>(self, on_discover: D2) -> DFS<V, D2, C>

Sets a callback invoked when a vertex is first discovered.

pub fn on_complete<C2: FnMut(V)>(self, on_complete: C2) -> DFS<V, D, C2>

Sets a callback invoked when backtracking from a vertex after all its neighbors have been processed.

pub fn discovered(self, discovered: HashSet<V>) -> Self

Provides a pre-populated discovered set, useful for resuming a traversal or excluding specific vertices.

pub fn reset(&mut self)

Clears the discovered set, allowing the DFS to revisit all vertices.

pub fn traverse<G>(&mut self, graph: &G, start_vertex: V)

where V: Clone + Eq + Hash, G: FinGraph<V = V>,

Traverses the graph depth-first starting from the given vertex.

Vertices already in the discovered set are skipped, and newly visited vertices are added to it. This allows multiple calls with different start vertices to share state.

Example

let mut discover_order = Vec::new();
let mut complete_order = Vec::new();
let mut dfs = DFS::new()
    .traversal_direction(TraversalDirection::Outward)
    .on_discover(|v| discover_order.push(v))
    .on_complete(|v| complete_order.push(v));
dfs.traverse(&graph, start_vertex);

Trait Implementations

impl<V: Debug, D, C> Debug for DFS<V, D, C>

where D: FnMut(V) + Debug, C: FnMut(V) + Debug,

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

Formats the value using the given formatter.

impl<V, D, C> Default for DFS<V, D, C>

where D: FnMut(V), C: FnMut(V),

fn default() -> Self

Returns the “default value” for a type.