Struct EdgeIndex

pub struct EdgeIndex(pub u32);

An edge identifier for a graph structure.

Tuple Fields

0: u32

Implementations

impl EdgeIndex

pub const END: EdgeIndex

A special index used to denote the abscence of an edge, for example at the end of an adjacency list.

Equivalent to EdgeIndex(u32::MAX).

pub fn index(self) -> usize

Returns the inner u32 value as a usize.

pub fn is_end(self) -> bool

Returns true if this is the special END index.

Trait Implementations

impl Clone for EdgeIndex

fn clone(&self) -> EdgeIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EdgeIndex

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

Formats the value using the given formatter.

impl Default for EdgeIndex

fn default() -> EdgeIndex

Returns the “default value” for a type.

impl From<u32> for EdgeIndex

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for EdgeIndex

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<N, E> Index<EdgeIndex> for UnGraph<N, E>

Indexes the UnGraph by EdgeIndex to access edge weights.

Panics

Panics if the edge doesn’t exist.

type Output = E

The returned type after indexing.

fn index(&self, index: EdgeIndex) -> &E

Performs the indexing (container[index]) operation.

impl<N, E> IndexMut<EdgeIndex> for UnGraph<N, E>

Indexes the UnGraph by EdgeIndex to access edge weights.

Panics

Panics if the edge doesn’t exist.

fn index_mut(&mut self, index: EdgeIndex) -> &mut E

Performs the mutable indexing (container[index]) operation.

impl Ord for EdgeIndex

fn cmp(&self, other: &EdgeIndex) -> 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 PartialEq for EdgeIndex

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

fn partial_cmp(&self, other: &EdgeIndex) -> 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 Copy for EdgeIndex

impl Eq for EdgeIndex

impl StructuralPartialEq for EdgeIndex