Struct plexus::graph::PathView

pub struct PathView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<VertexPayload<G>> + Consistent,
    G: GraphGeometry,  { /* fields omitted */ }

View of a path in a graph.

Provides a representation of non-intersecting paths in a graph. A path is conceptually an ordered set of vertices that are joined by arcs. A path over vertices $A$, $B$, and $C$ is notated $\overrightarrow{\{A, B, C\}}$.

Paths have no associated payload and do not directly expose geometry (PathView does not implement Deref or expose a geometry field). See the module documentation for more information about topological views.

Methods

impl<M, G> PathView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<VertexPayload<G>> + Consistent,
    G: GraphGeometry, 

pub fn push(
    &mut self,
    destination: Selector<VertexKey>
) -> Result<ArcKey, GraphError>

Pushes a vertex onto the path.

pub fn pop(&mut self) -> Option<ArcKey>

Pops the terminating vertex from the path.

pub fn pop_swap(&mut self, destination: Selector<VertexKey>) -> Option<ArcKey>

Exchanges the terminating vertex of the path.

Unlike pop, this function allows an existing path's originating arc to be changed by exchanging the destination vertex.

pub fn first(&self) -> VertexView<&M::Target, G>

Gets the initiating vertex of the path.

pub fn last(&self) -> VertexView<&M::Target, G>

Gets the terminating vertex of the path.

pub fn vertices(&self) -> impl Iterator<Item = VertexView<&M::Target, G>>

Gets an iterator over the vertices in the path.

pub fn arcs(&self) -> impl Iterator<Item = ArcView<&M::Target, G>>

Gets an iterator over the arcs in the path.

pub fn is_open(&self) -> bool

Returns true if the path is open.

An open path is a path that does not form a loop.

pub fn is_closed(&self) -> bool

Returns true if the path is closed.

A closed path is a path that forms a loop by starting and ending at the same vertex. Note that this exludes paths that self-intersect and include arcs that do not participate in loops. PathView disallows such paths.

impl<'a, M, G> PathView<&'a mut M, G> where
    M: 'a + AsStorage<ArcPayload<G>> + AsStorage<VertexPayload<G>> + AsStorageMut<ArcPayload<G>> + AsStorageMut<VertexPayload<G>> + Consistent,
    G: 'a + GraphGeometry, 

pub fn into_ref(self) -> PathView<&'a M, G>

Converts a mutable view into an immutable view.

This is useful when mutations are not (or no longer) needed and mutual access is desired.

Trait Implementations

impl<M: Clone, G: Clone> Clone for PathView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<VertexPayload<G>> + Consistent,
    G: GraphGeometry, 

fn clone(&self) -> PathView<M, G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, G> PartialEq<PathView<M, G>> for PathView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<VertexPayload<G>> + Consistent,
    G: GraphGeometry, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.