Struct WeightedPathResult 

pub struct WeightedPathResult {
    pub nodes: Vec<EntityId>,
    pub edges: Vec<EdgeId>,
    pub total_weight: f64,
    pub length: usize,
}

A weighted path through the graph.

Represents a sequence of nodes and edges from a source to a target, along with the total accumulated weight.

Fields

nodes: Vec<EntityId>

The nodes in the path, from source to target.

edges: Vec<EdgeId>

The edges connecting the nodes. Length is nodes.len() - 1.

total_weight: f64

The total weight of the path.

length: usize

The number of edges in the path.

Implementations

impl WeightedPathResult

pub fn new(nodes: Vec<EntityId>, edges: Vec<EdgeId>, total_weight: f64) -> Self

Create a new weighted path result.

pub fn single_node(node: EntityId) -> Self

Create a path for a single node (source == target).

pub fn source(&self) -> EntityId

Get the source node.

pub fn target(&self) -> EntityId

Get the target node.

Panics

Panics if the path is empty (should not happen with valid construction).

pub const fn is_empty(&self) -> bool

Check if the path is empty (source == target).

Trait Implementations

impl Clone for WeightedPathResult

fn clone(&self) -> WeightedPathResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WeightedPathResult

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

Formats the value using the given formatter.

impl PartialEq for WeightedPathResult

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