Struct DepthFirstTraversal 

pub struct DepthFirstTraversal<'a, N, E, A, H, S = DefaultHashBuilder>
where
    A: GraphProps,
    H: HyperGraph<N, E, A>,
{ /* private fields */ }

Depth-First Traversal algorithm for hypergraphs

Implementations

impl<'a, N, E, H, A, S> DepthFirstTraversal<'a, N, E, A, H, S>

where A: GraphProps, H: HyperGraph<N, E, A>, S: BuildHasher,

pub fn new(graph: &'a H) -> Self

where S: Default,

Create a new DepthFirstTraversal instance

pub const fn stack(&self) -> &Vec<VertexId<A::Ix>>

returns an immutable reference to the stack

pub const fn stack_mut(&mut self) -> &mut Vec<VertexId<A::Ix>>

returns a mutable reference to the stack

pub const fn visited(&self) -> &VertexSet<A::Ix, S>

returns an immutable reference to the visited vertices

pub const fn visited_mut(&mut self) -> &mut VertexSet<A::Ix, S>

returns a mutable reference to the visited vertices

pub fn has_visited<Q>(&self, vertex: &Q) -> bool

where A::Ix: Eq + Hash, Q: ?Sized + Eq + Hash, VertexId<A::Ix>: Borrow<Q>,

returns true if the vertex has been visited

pub fn reset(&mut self) -> &mut Self

reset the traversal state

pub fn search( &mut self, start: VertexId<A::Ix>, ) -> Result<<Self as Search<VertexId<A::Ix>>>::Output>

where Self: Search<VertexId<A::Ix>>, A::Ix: HyperIndex,

a convience method to perform a search

Trait Implementations

impl<'a, N, E, A, H, S> Search<IndexBase<<A as GraphProps>::Ix>> for DepthFirstTraversal<'a, N, E, A, H, S>

where A: GraphProps, H: HyperGraph<N, E, A>, S: BuildHasher, A::Ix: HyperIndex, for<'b> &'b <H::Edge<E> as RawLayout>::Store: IntoIterator<Item = &'b VertexId<A::Ix>>,

type Output = Vec<IndexBase<<A as GraphProps>::Ix>>

fn search(&mut self, start: VertexId<A::Ix>) -> Result<Self::Output>

begins a search of the graph, starting with the given index.

impl<'a, N, E, A, H, S> Traversal<IndexBase<<A as GraphProps>::Ix>> for DepthFirstTraversal<'a, N, E, A, H, S>

where A: GraphProps, H: HyperGraph<N, E, A>, S: BuildHasher, A::Ix: HashIndex,

type Store<I2> = HashSet<I2, S>

defines the associated container used to store visited vertices

fn has_visited(&self, vertex: &VertexId<A::Ix>) -> bool

Check if the search has visited a specific vertex

fn visited(&self) -> &Self::Store<VertexId<A::Ix>>

Get all vertices that have been visited during the search