Struct Path

pub struct Path { /* private fields */ }

A path from a src to a dst storing all edges in between.

Implementations

impl Path

pub fn new( src_idx: NodeIdx, src_id: i64, dst_idx: NodeIdx, dst_id: i64, edges: Vec<EdgeIdx>, ) -> Path

ATTENTION! This method does not calculate the path’s cost. This can be done, e.g., with calc_cost(...) or flatten(...). Accessing the costs without calculating them will lead to panics.

pub fn src_idx(&self) -> NodeIdx

pub fn dst_idx(&self) -> NodeIdx

pub fn costs(&self) -> &DimVec<f64>

ATTENTION! This method panics if the costs hasn’t been calculated (e.g. calc_cost(...) or flatten(...)).

pub fn calc_costs(&mut self, graph: &Graph) -> &DimVec<f64>

Calculates the path’s cost, but only if not calculated already.

pub fn try_flatten(self, graph: &Graph) -> Result<Path>

Flattens shortcuts, out-of-place, and calculates the flattened path’s cost.

pub fn flatten(self, graph: &Graph) -> Path

impl Path

pub fn iter(&self) -> Iter<'_, EdgeIdx>

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Display for Path

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Path

type Item = &'a EdgeIdx

The type of the elements being iterated over.

type IntoIter = Iter<'a, EdgeIdx>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, EdgeIdx>

Creates an iterator from a value.

impl IntoIterator for Path

type Item = EdgeIdx

The type of the elements being iterated over.

type IntoIter = IntoIter<EdgeIdx>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<EdgeIdx>

Creates an iterator from a value.

impl PartialEq for Path

fn eq(&self, other: &Path) -> 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 Eq for Path