Struct Lattice 

pub struct Lattice { /* private fields */ }

A directed acyclic lattice with one start node and one end node.

Nodes are addressed by zero-based indices. Arcs must move from lower to higher node indices so distance algorithms can process the lattice in topological order.

Implementations

impl Lattice

pub fn from_edges( node_count: usize, start: usize, end: usize, arcs: Vec<Arc>, ) -> Result<Lattice, LatticeError>

Builds a lattice from explicit nodes and arcs.

start and end must be valid node indices with start <= end. Every arc must reference valid nodes and satisfy src < dst.

pub fn from_paths<I, S>(paths: I) -> Lattice

where I: IntoIterator<Item = S>, S: AsRef<str>,

Builds a lattice from UTF-8 string paths.

Panics

Panics when paths is empty or when empty and non-empty paths are mixed. Use Lattice::try_from_paths to handle those cases as input errors.

pub fn try_from_paths<I, S>(paths: I) -> Result<Lattice, LatticeError>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Builds a lattice from UTF-8 string paths.

pub fn from_symbol_paths<I, P>(paths: I) -> Lattice

where I: IntoIterator<Item = P>, P: IntoIterator<Item = u32>,

Builds a lattice from symbol paths.

Panics

Panics when paths is empty or when empty and non-empty paths are mixed. Use Lattice::try_from_symbol_paths to handle those cases as input errors.

pub fn try_from_symbol_paths<I, P>(paths: I) -> Result<Lattice, LatticeError>

where I: IntoIterator<Item = P>, P: IntoIterator<Item = u32>,

Builds a lattice from symbol paths.

pub fn from_symbol_paths_compact<I, P>(paths: I) -> Lattice

where I: IntoIterator<Item = P>, P: IntoIterator<Item = u32>,

Builds a compact lattice from symbol paths by sharing common suffixes.

Panics

Panics when paths is empty or when empty and non-empty paths are mixed. Use Lattice::try_from_symbol_paths_compact to handle those cases as input errors.

pub fn try_from_symbol_paths_compact<I, P>( paths: I, ) -> Result<Lattice, LatticeError>

where I: IntoIterator<Item = P>, P: IntoIterator<Item = u32>,

Builds a compact lattice from symbol paths by sharing common suffixes.

pub fn node_count(&self) -> usize

Returns the number of nodes in the lattice.

pub fn start(&self) -> usize

Returns the start node index.

pub fn end(&self) -> usize

Returns the end node index.

pub fn arcs(&self) -> &[Arc]

Returns all arcs in insertion order.

pub fn try_incoming_arcs( &self, node: usize, ) -> Option<impl Iterator<Item = &Arc>>

Returns incoming arcs for node, or None when the node index is out of range.

pub fn incoming_arcs(&self, node: usize) -> impl Iterator<Item = &Arc>

Returns incoming arcs for node.

Panics

Panics when node >= self.node_count().

pub fn try_outgoing_arcs( &self, node: usize, ) -> Option<impl Iterator<Item = &Arc>>

Returns outgoing arcs for node, or None when the node index is out of range.

pub fn outgoing_arcs(&self, node: usize) -> impl Iterator<Item = &Arc>

Returns outgoing arcs for node.

Panics

Panics when node >= self.node_count().

Trait Implementations

impl Clone for Lattice

fn clone(&self) -> Lattice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lattice

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

Formats the value using the given formatter.

impl Eq for Lattice

impl PartialEq for Lattice

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Lattice