petgraph::graph

Struct NodeIndex

Source
pub struct NodeIndex<Ix = DefaultIx>(/* private fields */);
Expand description

Node identifier.

Implementations§

Source§

impl<Ix: IndexType> NodeIndex<Ix>

Source

pub fn new(x: usize) -> Self

Source

pub fn index(self) -> usize

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, Self: Sized,

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.

Source§

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> 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<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
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Ix: PartialOrd> PartialOrd 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

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

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

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

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> StructuralPartialEq for NodeIndex<Ix>

Auto Trait Implementations§

§

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

§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

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

Source§

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

Checks if this value is equivalent to the given key. Read more
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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

type NodeId = Ix

Source§

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,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.