Struct ShortestPathTree

pub struct ShortestPathTree<T: Display + Clone + Hash + Eq> { /* private fields */ }

Structure to store the shortest path and distance from one node to other nodes after a pathfinding algorithm has been run on a graph.

Implementations

impl<T: Display + Clone + Eq + Hash> ShortestPathTree<T>

pub fn shortest_path(&self, target_id: &T) -> Option<&ShortestPath<T>>

Returns the shortest path to the node with id target_id.

If the target_id is not contained within the shortest path tree, None is returned instead of the shortest path.

For further information and for what can be done with the shortest path see ShortestPath.

pub fn shortest_distance(&self, target_id: &T) -> Option<i32>

Returns the shortest distance to the node with id target_id.

If the target_id is not contained within the shortest path tree, None is returned instead of the distance.

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(1, &'a', &'b');
graph.add_edge(2, &'b', &'c');
 
let spt = dijkstra(&mut graph, &'a')?;
 
assert_eq!(spt.shortest_distance(&'b'), Some(1));
assert_eq!(spt.shortest_distance(&'c'), Some(3));
assert_eq!(spt.shortest_distance(&'d'), None);

Trait Implementations

impl<T: Debug + Display + Clone + Hash + Eq> Debug for ShortestPathTree<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Display + Clone + Hash + Eq> PartialEq for ShortestPathTree<T>

fn eq(&self, other: &ShortestPathTree<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: Eq + Display + Clone + Hash + Eq> Eq for ShortestPathTree<T>

impl<T: Display + Clone + Hash + Eq> StructuralPartialEq for ShortestPathTree<T>