Struct petgraph::graph::NodeIndex

source · [−]

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

Expand description

Node identifier.

Implementations

source

pub fn end() -> Self

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn default() -> NodeIndex<Ix>

Returns the “default value” for a type. Read more

source

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

source

fn from(ix: Ix) -> Self

Converts to this type from the input type.

source

impl<Ix: Hash> Hash for NodeIndex<Ix>

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

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.

type Output = N

The returned type after indexing.

source

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

Performs the indexing (container[index]) operation. Read more

source

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.

type Output = N

The returned type after indexing.

source

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

Performs the indexing (container[index]) operation. Read more

source

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.

type Output = N

The returned type after indexing.

source

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

Performs the indexing (container[index]) operation. Read more

source

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.

source

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

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

source

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.

source

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

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

source

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.

source

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

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

source

impl<Ix: IndexType> IndexType for NodeIndex<Ix>

source

fn index(&self) -> usize

source

fn new(x: usize) -> Self

source

fn max() -> Self

source

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

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl<Ix: PartialEq> PartialEq<NodeIndex<Ix>> for NodeIndex<Ix>

source

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

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

source

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

This method tests for !=.

source

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

source

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

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

1.0.0 · source

fn lt(&self, other: &Rhs) -> bool

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

1.0.0 · source

fn le(&self, other: &Rhs) -> bool

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

1.0.0 · source

fn gt(&self, other: &Rhs) -> bool

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

1.0.0 · source

fn ge(&self, other: &Rhs) -> bool

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

source

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

source

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

source

impl<Ix: IndexType> GraphIndex for NodeIndex<Ix>

source

impl<Ix> StructuralEq for NodeIndex<Ix>

source

impl<Ix> StructuralPartialEq for NodeIndex<Ix>

Auto Trait Implementations

impl<Ix> RefUnwindSafe for NodeIndex<Ix> where
Ix: RefUnwindSafe,

impl<Ix> Send for NodeIndex<Ix> where
Ix: Send,

impl<Ix> Sync for NodeIndex<Ix> where
Ix: Sync,

impl<Ix> Unpin for NodeIndex<Ix> where
Ix: Unpin,

impl<Ix> UnwindSafe for NodeIndex<Ix> where
Ix: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> CallHasher for T where
T: Hash + ?Sized,

source

fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<Ix> NodeRef for Ix where
Ix: IndexType,

type NodeId = Ix

type Weight = ()

source

fn id(&self) -> <Ix as NodeRef>::NodeId

source

fn weight(&self) -> &<Ix as NodeRef>::Weight

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct petgraph::graph::NodeIndex

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>

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

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

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

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

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

fn default() -> NodeIndex<Ix>

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

fn from(ix: Ix) -> Self

impl<Ix: Hash> Hash for NodeIndex<Ix>

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl<N, E, Ty, Ix> Index<NodeIndex<Ix>> for Graph<N, E, Ty, Ix> where Ty: EdgeType, Ix: IndexType,

type Output = N

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

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

type Output = N

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

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

type Output = N

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

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

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

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

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

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

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

impl<Ix: IndexType> IndexType for NodeIndex<Ix>

fn index(&self) -> usize

fn new(x: usize) -> Self

fn max() -> Self

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

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

fn max(self, other: Self) -> Self

fn min(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl<Ix: PartialEq> PartialEq<NodeIndex<Ix>> for NodeIndex<Ix>

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

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

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

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

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

fn gt(&self, other: &Rhs) -> bool

fn ge(&self, other: &Rhs) -> bool

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

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

impl<Ix: IndexType> GraphIndex for NodeIndex<Ix>

impl<Ix> StructuralEq for NodeIndex<Ix>

impl<Ix> StructuralPartialEq for NodeIndex<Ix>

Auto Trait Implementations

impl<Ix> RefUnwindSafe for NodeIndex<Ix> where Ix: RefUnwindSafe,

impl<Ix> Send for NodeIndex<Ix> where Ix: Send,

impl<Ix> Sync for NodeIndex<Ix> where Ix: Sync,

impl<Ix> Unpin for NodeIndex<Ix> where Ix: Unpin,

impl<Ix> UnwindSafe for NodeIndex<Ix> where Ix: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<Ix> NodeRef for Ix where Ix: IndexType,

type NodeId = Ix

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<N, E, Ty, Ix> Index<NodeIndex<Ix>> for Graph<N, E, Ty, Ix> where
Ty: EdgeType,
Ix: IndexType,

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

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

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

impl<Ix> RefUnwindSafe for NodeIndex<Ix> where
Ix: RefUnwindSafe,

impl<Ix> Send for NodeIndex<Ix> where
Ix: Send,

impl<Ix> Sync for NodeIndex<Ix> where
Ix: Sync,

impl<Ix> Unpin for NodeIndex<Ix> where
Ix: Unpin,

impl<Ix> UnwindSafe for NodeIndex<Ix> where
Ix: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<Ix> NodeRef for Ix where
Ix: IndexType,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<N> NodeTrait for N where
N: Copy + Ord + Hash,