Struct Node 

#[repr(C)]
pub struct Node<T, Ix = Udx> { /* private fields */ }

The Node implementation generically associates a VertexId with a Weight.

Implementations

impl<T, Ix> Node<T, Ix>

where Ix: RawIndex,

pub const fn new(id: VertexId<Ix>, weight: T) -> Self

initialize a new instance with the given index and weight

pub fn from_id(index: VertexId<Ix>) -> Self

where T: Default,

returns a new weighted node using the given value and the logical default for the index

pub fn from_weight(Weight: Weight<T>) -> Self

where Ix: Default,

creates a new node with the given index using the logical default for the weight.

pub fn with_id<I2: RawIndex>(self, index: VertexId<I2>) -> Node<T, I2>

consumes the current instance to create another with the given index.

pub fn with_weight<U>(self, weight: Weight<U>) -> Node<U, Ix>

consumes the current instance to create another with the given weight.

pub const fn as_tuple(&self) -> (&VertexId<Ix>, &Weight<T>)

converts the node into a 2-tuple consisting of the node index and the weight:

• 0: a reference to the node index
• 1: a reference to the node weight

pub fn into_tuple(self) -> (VertexId<Ix>, Weight<T>)

consumes the node to convert it into a 2-tuple consisting of the node index and the weight

pub fn as_tuple_mut(&mut self) -> (&VertexId<Ix>, &mut Weight<T>)

returns the node as a tuple with a mutable reference to the weight such that:

• 0: a reference to the node index
• 1: a mutable reference to the node weight

this method is useful for converting the node into a standard item produced by mutable key-value iterators where Item = (&'a K, &'a mut V)

pub const fn id(&self) -> &VertexId<Ix>

returns an immutable reference to the node index

pub const fn weight(&self) -> &Weight<T>

returns an immutable reference to the node weight

pub const fn weight_mut(&mut self) -> &mut Weight<T>

returns a mutable reference to the node weight

pub fn set_weight(&mut self, weight: T) -> &mut Self

update the weight and return a mutable reference to the current instance.

pub const fn replace_weight(&mut self, weight: T) -> Weight<T>

replace the weight of the current instance with the given weight, returning the previous weight.

pub fn swap_weight(&mut self, other: &mut Self)

swap the weight of the current instance with the weight of another instance.

pub fn map<U, F>(self, f: F) -> Node<U, Ix>

where F: FnOnce(T) -> U,

consumes the current instance and applies the given function onto the weight, returning a new instance with the same index and the resulting weight.

pub fn map_mut<F>(&mut self, f: F) -> &mut Self

where F: FnOnce(&mut T),

consumes the current instance and applies the given function onto the weight,

impl<T, Idx> Node<UnWeight<T>, Idx>

where Idx: RawIndex,

pub const fn weightless(id: VertexId<Idx>) -> Self

returns a new, weightless node with the given index

pub fn init_weight<F>(self, init: F) -> Node<T, Idx>

where F: FnOnce() -> T,

initialize the weight of the node with the given value

Trait Implementations

impl<T, Idx> AsMut<Weight<T>> for Node<T, Idx>

where Idx: RawIndex,

fn as_mut(&mut self) -> &mut Weight<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, Idx> AsRef<Weight<T>> for Node<T, Idx>

where Idx: RawIndex,

fn as_ref(&self) -> &Weight<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, Idx> Borrow<IndexBase<Idx>> for Node<T, Idx>

where Idx: RawIndex,

fn borrow(&self) -> &VertexId<Idx>

Immutably borrows from an owned value.

impl<T, Idx> Borrow<Weight<T>> for Node<T, Idx>

where Idx: RawIndex,

fn borrow(&self) -> &Weight<T>

Immutably borrows from an owned value.

impl<T, Idx> BorrowMut<Weight<T>> for Node<T, Idx>

where Idx: RawIndex,

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

Mutably borrows from an owned value.

impl<T: Clone, Ix: Clone> Clone for Node<T, Ix>

fn clone(&self) -> Node<T, Ix>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Ix: Debug> Debug for Node<T, Ix>

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

Formats the value using the given formatter.

impl<T, Idx> Default for Node<T, Idx>

where Idx: RawIndex + Default, T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T, Idx> Deref for Node<T, Idx>

where Idx: RawIndex,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, Idx> DerefMut for Node<T, Idx>

where Idx: RawIndex,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T, Ix> Deserialize<'de> for Node<T, Ix>

where T: Deserialize<'de>, Ix: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, Idx> Display for Node<T, Idx>

where Idx: RawIndex + Display, T: Display,

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

Formats the value using the given formatter.

impl<T, Idx> From<(IndexBase<Idx>, Weight<T>)> for Node<T, Idx>

where Idx: RawIndex,

fn from((index, Weight): (VertexId<Idx>, Weight<T>)) -> Self

Converts to this type from the input type.

impl<T, Idx> From<IndexBase<Idx>> for Node<T, Idx>

where Idx: RawIndex, T: Default,

fn from(index: VertexId<Idx>) -> Self

Converts to this type from the input type.

impl<T, Idx> From<Node<T, Idx>> for (VertexId<Idx>, Weight<T>)

where Idx: RawIndex,

fn from(node: Node<T, Idx>) -> Self

Converts to this type from the input type.

impl<T, Idx> From<Node<T, Idx>> for VertexId<Idx>

where Idx: RawIndex,

fn from(node: Node<T, Idx>) -> Self

Converts to this type from the input type.

impl<T, Idx> From<Weight<T>> for Node<T, Idx>

where Idx: Default + RawIndex,

fn from(weight: Weight<T>) -> Self

Converts to this type from the input type.

impl<T: Hash, Ix: Hash> Hash for Node<T, 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, Idx> HyperNode<T> for Node<T, Idx>

where Idx: RawIndex,

fn index(&self) -> &VertexId<Idx>

returns an immutable reference to the node index

fn weight(&self) -> &Weight<T>

returns an immutable reference to the node data

fn weight_mut(&mut self) -> &mut Weight<T>

returns a mutable reference to the node data

fn replace_weight(&mut self, weight: Weight<T>) -> Weight<T>

replace the weight of the node with a new one, returning the previous value

fn set_weight(&mut self, weight: T) -> &mut Self

overwrites the weight of the node with a new one and returns a mutable reference to the edge.

fn swap_weight(&mut self, weight: &mut Weight<T>)

swap the weight of the node with another weight

fn take_weight(&mut self) -> Weight<T>

where T: Default,

take the weight of the node, replacing it with a default value

impl<T, Id> HyperPoint for Node<T, Id>

where Id: RawIndex,

fn index(&self) -> &VertexId<Self::Key>

returns the index of the point as a VertexId.

fn raw_index(&self) -> &Self::Key

returns the raw index of the point as a reference to the underlying key type.

impl<T, Idx> Indexed<Idx> for Node<T, Idx>

where Idx: RawIndex,

type Idx<I> = IndexBase<I>

fn index(&self) -> &Self::Idx<Idx>

Returns the index of the node.

impl<T: Ord, Ix: Ord> Ord for Node<T, Ix>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, Ix: PartialEq> PartialEq for Node<T, Ix>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd, Ix: PartialOrd> PartialOrd for Node<T, Ix>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, Idx> RawNode<T> for Node<T, Idx>

where Idx: RawIndex,

type Key = Idx

impl<T, Id> RawPoint for Node<T, Id>

where Id: RawIndex,

type Key = Id

impl<T, Ix> Serialize for Node<T, Ix>

where T: Serialize, Ix: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy, Ix: Copy> Copy for Node<T, Ix>

impl<T: Eq, Ix: Eq> Eq for Node<T, Ix>

impl<T, Ix> StructuralPartialEq for Node<T, Ix>