Struct petgraph::graph::NodeIndex

[+] Show declaration

pub struct NodeIndex<Ix = DefaultIx>(_);

[−] Expand description

Node identifier.

Implementations

impl<Ix: IndexType> NodeIndex<Ix>[−]

pub fn new(x: usize) -> Self

pub fn index(self) -> usize

pub fn end() -> Self

Trait Implementations

impl<Ix: Clone> Clone for NodeIndex<Ix>[+]

[+] Show hidden undocumented items

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>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<Ix: Default> Default for NodeIndex<Ix>[+]

[+] Show hidden undocumented items

fn default() -> NodeIndex<Ix>[−]

Returns the "default value" for a type.

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

impl<Ix: IndexType> From<Ix> for NodeIndex<Ix>[+]

[+] Show hidden undocumented items

fn from(ix: Ix) -> Self[−]

Performs the conversion.

impl<Ix: IndexType> GraphIndex for NodeIndex<Ix>[+]

[+] Show hidden undocumented items

fn index(&self) -> usize

fn is_node_index() -> bool

impl<Ix: Hash> Hash for NodeIndex<Ix>[+]

[+] Show hidden undocumented items

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<N, E, Ty, Ix> Index<NodeIndex<Ix>> for Graph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, [+]

Index the Graph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[+] Show hidden undocumented items

type Output = N

The returned type after indexing.

fn index(&self, index: NodeIndex<Ix>) -> &N[−]

Performs the indexing (container[index]) operation.

impl<N, E, Ty, Ix> Index<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, [+]

Index the StableGraph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[+] Show hidden undocumented items

type Output = N

The returned type after indexing.

fn index(&self, index: NodeIndex<Ix>) -> &N[−]

Performs the indexing (container[index]) operation.

impl<N, E, Ty: EdgeType, Null: Nullable<Wrapped = E>, Ix: IndexType> Index<NodeIndex<Ix>> for MatrixGraph<N, E, Ty, Null, Ix>[+]

Index the MatrixGraph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[+] Show hidden undocumented items

type Output = N

The returned type after indexing.

fn index(&self, ax: NodeIndex<Ix>) -> &N[−]

Performs the indexing (container[index]) operation.

impl<N, E, Ty, Ix> IndexMut<NodeIndex<Ix>> for Graph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, [+]

Index the Graph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[+] Show hidden undocumented items

fn index_mut(&mut self, index: NodeIndex<Ix>) -> &mut N[−]

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

impl<N, E, Ty, Ix> IndexMut<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType, [+]

Index the StableGraph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[+] Show hidden undocumented items

fn index_mut(&mut self, index: NodeIndex<Ix>) -> &mut N[−]

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

impl<N, E, Ty: EdgeType, Null: Nullable<Wrapped = E>, Ix: IndexType> IndexMut<NodeIndex<Ix>> for MatrixGraph<N, E, Ty, Null, Ix>[+]

Index the MatrixGraph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[+] Show hidden undocumented items

fn index_mut(&mut self, ax: NodeIndex<Ix>) -> &mut N[−]

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

impl<Ix: Ord> Ord for NodeIndex<Ix>[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &NodeIndex<Ix>) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

#[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>[+]

[+] Show hidden undocumented items

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>[+]

[+] Show hidden undocumented items

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>

impl<Ix> VisitMap<NodeIndex<Ix>> for FixedBitSet where
    Ix: IndexType, [+]

[+] Show hidden undocumented items

fn visit(&mut self, x: NodeIndex<Ix>) -> bool[−]

Mark a as visited.

fn is_visited(&self, x: &NodeIndex<Ix>) -> bool[−]

Return whether a has been visited before.