Struct outils::types::NodeIndex

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

Newtype to be used as a type-safe tree node identifier

Implementations

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

pub fn index(&self) -> Ix

Returns the wrapped index value

Trait Implementations

impl<Ix: Clone> Clone for NodeIndex<Ix>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ix: Copy> Copy for NodeIndex<Ix>

impl<Ix: Debug> Debug for NodeIndex<Ix>

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

Formats the value using the given formatter.

impl<Ix: Default> Default for NodeIndex<Ix>

fn default() -> NodeIndex<Ix>

Returns the "default value" for a type.

impl<Ix: Eq> Eq for NodeIndex<Ix>

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

fn from(ix: Ix) -> Self

Performs the conversion.

impl<Ix: Hash> Hash for NodeIndex<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<V> Index<NodeIndex<usize>> for AaForest<V> where
    V: ValueType, 

type Output = V

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &V

Performs the indexing (container[index]) operation.

impl<K, V> Index<NodeIndex<usize>> for AaTree<K, V> where
    K: KeyType,
    V: ValueType, 

type Output = V

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &V

Performs the indexing (container[index]) operation.

impl<V, W> Index<NodeIndex<usize>> for WeightedAaForest<V, W> where
    V: ValueType,
    W: WeightType, 

type Output = V

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &V

Performs the indexing (container[index]) operation.

impl<K, V, W> Index<NodeIndex<usize>> for WeightedAaTree<K, V, W> where
    K: KeyType,
    V: ValueType,
    W: WeightType, 

type Output = V

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &V

Performs the indexing (container[index]) operation.

impl<V> Index<NodeIndex<usize>> for Forest<V> where
    V: ValueType, 

type Output = V

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &V

Performs the indexing (container[index]) operation.

impl<V> IndexMut<NodeIndex<usize>> for AaForest<V> where
    V: ValueType, 

fn index_mut(&mut self, index: NodeIndex) -> &mut V

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

impl<K, V> IndexMut<NodeIndex<usize>> for AaTree<K, V> where
    K: KeyType,
    V: ValueType, 

fn index_mut(&mut self, index: NodeIndex) -> &mut V

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

impl<V, W> IndexMut<NodeIndex<usize>> for WeightedAaForest<V, W> where
    V: ValueType,
    W: WeightType, 

fn index_mut(&mut self, index: NodeIndex) -> &mut V

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

impl<K, V, W> IndexMut<NodeIndex<usize>> for WeightedAaTree<K, V, W> where
    K: KeyType,
    V: ValueType,
    W: WeightType, 

fn index_mut(&mut self, index: NodeIndex) -> &mut V

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

impl<V> IndexMut<NodeIndex<usize>> for Forest<V> where
    V: ValueType, 

fn index_mut(&mut self, index: NodeIndex) -> &mut V

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

impl<Ix: Ord> Ord for NodeIndex<Ix>

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

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

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

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

This method tests for !=.

impl<Ix: PartialOrd> PartialOrd<NodeIndex<Ix>> for NodeIndex<Ix>

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

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

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

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

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

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

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

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

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

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

impl<Ix> StructuralEq for NodeIndex<Ix>

impl<Ix> StructuralPartialEq for NodeIndex<Ix>