Struct ShortestPath

pub struct ShortestPath<T: Display + Clone> { /* private fields */ }

The shortest path from one node to another.

Implementations

impl<T: Display + Clone> ShortestPath<T>

pub fn source(&self) -> Option<&T>

Id of source node where this shortest path starts.

Example

use simple_graph_algorithms::{Graph, algorithms::dijkstra};
 
let mut graph = Graph::new();
graph.add_node('a');
graph.add_node('b');
graph.add_edge(4, &'a', &'b');
let spt = dijkstra(&mut graph, &'a')?;
 
// Calculate shortest path from a to b using dijkstra's algorithm.
// It is ok to use .unwrap() here, because we know that the graph contains node b.
let shortest_path = spt.shortest_path(&'b').unwrap();
 
assert_eq!(shortest_path.source(), Some(&'a'));

pub fn target(&self) -> Option<&T>

Id of target node where this shortest path ends.

Example

use simple_graph_algorithms::{Graph, algorithms::dijkstra};
 
let mut graph = Graph::new();
graph.add_node('a');
graph.add_node('b');
graph.add_edge(4, &'a', &'b');
let spt = dijkstra(&mut graph, &'a')?;
 
// Calculate shortest path from a to b using dijkstra's algorithm.
// It is ok to use .unwrap() here, because we know that the graph contains node b.
let shortest_path = spt.shortest_path(&'b').unwrap();
 
assert_eq!(shortest_path.target(), Some(&'b'));

pub fn path(&self) -> &Vec<T>

Id’s of nodes that form the shortest path.

First element is the id of the start node. Last element is the id of the target node.

Example

use simple_graph_algorithms::{Graph, algorithms::dijkstra};
 
let mut graph = Graph::new();
graph.add_node('a');
graph.add_node('b');
graph.add_node('c');
graph.add_edge(4, &'a', &'b');
graph.add_edge(2, &'b', &'c');
let spt = dijkstra(&mut graph, &'a')?;
 
// Calculate shortest path from a to c using dijkstra's algorithm.
// It is ok to use .unwrap() here, because we know that the graph contains node c.
let shortest_path = spt.shortest_path(&'c').unwrap();
 
assert_eq!(shortest_path.path(), &vec!['a', 'b', 'c']);

Trait Implementations

impl<T: Clone + Display + Clone> Clone for ShortestPath<T>

fn clone(&self) -> ShortestPath<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Display + Clone> Debug for ShortestPath<T>

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

Formats the value using the given formatter.

impl<T: Display + Clone + Debug> Display for ShortestPath<T>

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

Formats the shortest path in a way that can be printed easily.

Example

use simple_graph_algorithms::{Graph, algorithms::dijkstra};
 
let mut graph = Graph::new();
graph.add_node('a');
graph.add_node('b');
graph.add_node('c');
graph.add_edge(4, &'a', &'b');
graph.add_edge(2, &'b', &'c');
let spt = dijkstra(&mut graph, &'a')?;
 
// Calculate shortest path from a to c using dijkstra's algorithm.
// It is ok to use .unwrap() here, because we know that the graph contains node c.
let shortest_path = spt.shortest_path(&'c').unwrap();
 
assert_eq!(shortest_path.to_string(), "a -> b -> c");

impl<T: Hash + Display + Clone> Hash for ShortestPath<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + Display + Clone> Ord for ShortestPath<T>

fn cmp(&self, other: &ShortestPath<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + Display + Clone> PartialEq for ShortestPath<T>

fn eq(&self, other: &ShortestPath<T>) -> bool

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

const 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<T: PartialOrd + Display + Clone> PartialOrd for ShortestPath<T>

fn partial_cmp(&self, other: &ShortestPath<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + Display + Clone> Eq for ShortestPath<T>

impl<T: Display + Clone> StructuralPartialEq for ShortestPath<T>