Struct lattice_graph::square::NodeIndex

pub struct NodeIndex<Ix: IndexType> {
    pub horizontal: Ix,
    pub vertical: Ix,
}

Node index for SquareGraph

Fields

horizontal: Ix

vertical: Ix

Implementations

impl<Ix: IndexType> NodeIndex<Ix>

pub fn new(horizontal: Ix, vertical: Ix) -> Self

Create a Index from horizontal and vertical.

pub fn distance<T: Into<(usize, usize)>>(&self, target: T) -> usize

Returns the manhattan distance

pub unsafe fn get_edge_id_unchecked(
    &self,
    dir: SquareDirection
) -> EdgeIndex<Ix>

Get the edge from this node. This does not check whether the node is valid in graph.

pub fn up(self) -> Self

pub fn down(self) -> Self

pub fn right(self) -> Self

pub fn left(self) -> Self

Trait Implementations

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

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 + IndexType> Debug for NodeIndex<Ix>

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

Formats the value using the given formatter.

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

fn default() -> NodeIndex<Ix>

Returns the “default value” for a type.

impl<Ix: IndexType> From<(usize, usize)> for NodeIndex<Ix>

fn from(value: (usize, usize)) -> Self

Performs the conversion.

impl<Ix: IndexType> From<NodeIndex<Ix>> for (usize, usize)

fn from(value: NodeIndex<Ix>) -> Self

Performs the conversion.

impl<Ix: Hash + IndexType> Hash for NodeIndex<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, 

Feeds a slice of this type into the given Hasher.

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

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) -> Self

Restrict a value to a certain interval.

impl<Ix: IndexType> PartialEq<(usize, usize)> for NodeIndex<Ix>

fn eq(&self, value: &(usize, usize)) -> 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 !=.

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

This method tests for !=.

impl<Ix: PartialOrd + IndexType> PartialOrd<NodeIndex<Ix>> for NodeIndex<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: IndexType> VisitMap<NodeIndex<Ix>> for VisMap

fn visit(&mut self, a: NodeIndex<Ix>) -> bool

Mark a as visited.

fn is_visited(&self, a: &NodeIndex<Ix>) -> bool

Return whether a has been visited before.

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

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

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

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