Struct outils::types::Edge

pub struct Edge<Ix = DefaultIndexType> { /* fields omitted */ }

Light-weight, read-only type holding an edge index and the two vertices connected by the indexed edge, i.e. e = (v, w)

Implementations

impl<Ix> Edge<Ix> where
    Ix: IndexType, 

pub fn new(
    index: EdgeIndex<Ix>,
    src: VertexIndex<Ix>,
    dst: VertexIndex<Ix>
) -> Self

Construct a new Edge from an edge index value and the two vertex indices connected by the new edge, i.e. e = (src, dst).

pub fn index(&self) -> EdgeIndex<Ix>

Returns the wrapped edge index value

pub fn src(&self) -> VertexIndex<Ix>

Returns the wrapped index of the source vertex

pub fn dst(&self) -> VertexIndex<Ix>

Returns the wrapped index of the destination vertex

Trait Implementations

impl<Ix: Clone> Clone for Edge<Ix>

fn clone(&self) -> Edge<Ix>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ix: Copy> Copy for Edge<Ix>

impl<Ix: Debug> Debug for Edge<Ix>

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

Formats the value using the given formatter.

impl<Ix: Default> Default for Edge<Ix>

fn default() -> Edge<Ix>

Returns the "default value" for a type.

impl<Ix: Eq> Eq for Edge<Ix>

impl<Ix: Hash> Hash for Edge<Ix>

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, 

Feeds a slice of this type into the given Hasher.

impl<Ix: Ord> Ord for Edge<Ix>

fn cmp(&self, other: &Edge<Ix>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Ix: PartialEq> PartialEq<Edge<Ix>> for Edge<Ix>

fn eq(&self, other: &Edge<Ix>) -> bool

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

fn ne(&self, other: &Edge<Ix>) -> bool

This method tests for !=.

impl<Ix: PartialOrd> PartialOrd<Edge<Ix>> for Edge<Ix>

fn partial_cmp(&self, other: &Edge<Ix>) -> Option<Ordering>

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

fn lt(&self, other: &Edge<Ix>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Edge<Ix>) -> bool

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

fn gt(&self, other: &Edge<Ix>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Edge<Ix>) -> bool

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

impl<Ix> StructuralEq for Edge<Ix>

impl<Ix> StructuralPartialEq for Edge<Ix>