Struct outils::types::VertexIndex

pub struct VertexIndex<Ix = DefaultIndexType>(pub Ix);

Newtype to be used as a type-safe vertex identifier

Implementations

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

pub fn index(&self) -> Ix

Returns the wrapped index value

Trait Implementations

impl<Ix: Clone> Clone for VertexIndex<Ix>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ix: Copy> Copy for VertexIndex<Ix>

impl<Ix: Debug> Debug for VertexIndex<Ix>

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

Formats the value using the given formatter.

impl<Ix: Default> Default for VertexIndex<Ix>

fn default() -> VertexIndex<Ix>

Returns the "default value" for a type.

impl<Ix: Eq> Eq for VertexIndex<Ix>

impl<Ix> From<Ix> for VertexIndex<Ix> where
    Ix: IndexType, 

fn from(ix: Ix) -> Self

Performs the conversion.

impl<Ix: Hash> Hash for VertexIndex<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 VertexIndex<Ix>

fn cmp(&self, other: &VertexIndex<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<VertexIndex<Ix>> for VertexIndex<Ix>

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

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

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

This method tests for !=.

impl<Ix: PartialOrd> PartialOrd<VertexIndex<Ix>> for VertexIndex<Ix>

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

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

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

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

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

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

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

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

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

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

impl<Ix> StructuralEq for VertexIndex<Ix>

impl<Ix> StructuralPartialEq for VertexIndex<Ix>