Struct osmgraphing::routing::paths::Path

source · [−]

pub struct Path { /* private fields */ }

Expand description

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

Implementations

source

impl Path

source

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.

source

pub fn src_idx(&self) -> NodeIdx

source

pub fn dst_idx(&self) -> NodeIdx

source

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

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

source

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

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

source

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

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

source

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

source

impl Path

source

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

Trait Implementations

source

impl Clone for Path

source

fn clone(&self) -> Path

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Path

source

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

Formats the value using the given formatter. Read more

source

impl Display for Path

source

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

Formats the value using the given formatter. Read more

source

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?

source

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

Creates an iterator from a value. Read more

source

impl IntoIterator for Path

type Item = EdgeIdx

The type of the elements being iterated over.

type IntoIter = IntoIter<EdgeIdx, Global>

Which kind of iterator are we turning this into?

source

fn into_iter(self) -> IntoIter<EdgeIdx>

Creates an iterator from a value. Read more

source

impl PartialEq<Path> for Path

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl Eq for Path

Auto Trait Implementations

impl RefUnwindSafe for Path

impl Send for Path

impl Sync for Path

impl Unpin for Path

impl UnwindSafe for Path

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct osmgraphing::routing::paths::Path

Implementations

impl Path

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

pub fn src_idx(&self) -> NodeIdx

pub fn dst_idx(&self) -> NodeIdx

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

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

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

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

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

impl Debug for Path

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

impl Display for Path

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

impl<'a> IntoIterator for &'a Path

type Item = &'a EdgeIdx

type IntoIter = Iter<'a, EdgeIdx>

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

impl IntoIterator for Path

type Item = EdgeIdx

type IntoIter = IntoIter<EdgeIdx, Global>

fn into_iter(self) -> IntoIter<EdgeIdx>

impl PartialEq<Path> for Path

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

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

impl Eq for Path

Auto Trait Implementations

impl RefUnwindSafe for Path

impl Send for Path

impl Sync for Path

impl Unpin for Path

impl UnwindSafe for Path

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,