Struct consalign::NodeIndex

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

Node identifier.

Implementations

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

pub fn new(x: usize) -> NodeIndex<Ix>

pub fn index(self) -> usize

pub fn end() -> NodeIndex<Ix>

Trait Implementations

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

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> Debug for NodeIndex<Ix>where
    Ix: Debug,

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

Formats the value using the given formatter.

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

fn default() -> NodeIndex<Ix>

Returns the “default value” for a type.

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

fn from(ix: Ix) -> NodeIndex<Ix>

Converts to this type from the input type.

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

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

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.

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> 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.

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

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

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

fn index(&self) -> usize

fn new(x: usize) -> NodeIndex<Ix>

fn max() -> NodeIndex<Ix>

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<Ix> PartialEq<NodeIndex<Ix>> for NodeIndex<Ix>where
    Ix: PartialEq<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: &Rhs) -> bool

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

impl<Ix> PartialOrd<NodeIndex<Ix>> for NodeIndex<Ix>where
    Ix: PartialOrd<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: &Rhs) -> bool

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

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

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

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

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

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

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

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

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

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

impl<Ix> StructuralEq for NodeIndex<Ix>

impl<Ix> StructuralPartialEq for NodeIndex<Ix>