Struct Edge

pub struct Edge<T, A>
where
    T: PartialOrd + Send,
{
    pub u: T,
    pub v: T,
    pub attributes: Option<A>,
    pub weight: f64,
}

Represents a graph edge as (u, v).

Also allows attributes, as a HashMap, to be stored on an edge.

Fields

u: T

The name of the first node of the edge.

v: T

The name of the second node of the edge.

attributes: Option<A>

Any attributes of the edge.

weight: f64

The edge weight. For weighted Graph this should be a real number. For an unweighted Graph this should be f64:NAN.

Implementations

impl<T, A> Edge<T, A>

where T: Eq + Clone + PartialOrd + Ord + Hash + Send + Sync + Display, A: Clone,

pub fn new(u: T, v: T) -> Arc<Edge<T, A>>

Creates a new Edge with no attributes.

Arguments

• u: The name of the first node of the edge.
• v: The name of the second node of the edge.

Examples

use graphrs::Edge;
let edges = vec![
    Edge::<&str, ()>::new("n1", "n2"),
    Edge::<&str, ()>::new("n2", "n1"),
];

pub fn ordered(self: &Edge<T, A>) -> Edge<T, A>

Returns (v, u) if u > v.

use graphrs::Edge;
let edge1 = Edge::<&str, ()>::new("n2", "n1");
let edge2 = edge1.ordered();
assert_eq!(edge2.u, "n1");
assert_eq!(edge2.v, "n2");

pub fn reversed(self: &Edge<T, A>) -> Edge<T, A>

Reverses the edge. (u, v) -> (v, u)

use graphrs::Edge;
let edge1 = Edge::<&str, ()>::new("n2", "n1");
let edge2 = edge1.reversed();
assert_eq!(edge2.u, "n1");
assert_eq!(edge2.v, "n2");

pub fn with_weight(u: T, v: T, weight: f64) -> Arc<Edge<T, A>>

Creates a (u, v) Edge with a specified weight.

Arguments

• u: The name of the first node of the edge.
• v: The name of the second node of the edge.
• weight: The weight of the edge.

Examples

use graphrs::Edge;
let edges = vec![
    Edge::<&str, ()>::with_weight("n1", "n2", 1.0),
    Edge::<&str, ()>::with_weight("n2", "n1", 2.0),
];

Trait Implementations

impl<T, A: Clone> Clone for Edge<T, A>

where T: PartialOrd + Send + Clone,

fn clone(&self) -> Edge<T, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + PartialOrd + Send + Sync, A> Debug for Edge<T, A>

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

Formats the value using the given formatter.

impl<T: Display + PartialOrd + Send + Sync, A> Display for Edge<T, A>

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

Formats the value using the given formatter.

impl<T: Hash + PartialOrd + Send + Sync, A> Hash for Edge<T, A>

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: Eq + PartialOrd + Send + Sync, A> Ord for Edge<T, A>

fn cmp(&self, other: &Self) -> 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 + PartialOrd + Send + Sync, A> PartialEq for Edge<T, A>

fn eq(&self, other: &Self) -> 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<T: Eq + PartialEq + PartialOrd + Send + Sync, A> PartialOrd for Edge<T, A>

fn partial_cmp(&self, other: &Self) -> 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 + PartialOrd + Send + Sync, A> Eq for Edge<T, A>