Enum lattice_graph::hex::shapes::AxisDR

pub enum AxisDR {
    NE,
    E,
    SE,
    SW,
    W,
    NW,
}

Point top Directed Hex Direcion.

Variants

NE

E

SE

SW

W

NW

Trait Implementations

impl Axis for AxisDR

const COUNT: usize

Number of axis.

const DIRECTED: bool

Whether it is Directed or not.

type Direction = Self

For tricks to optimize for undirected graph, and not to regress performance of directed graph. If the axis is DIRECTED, should set Self.

fn to_index(&self) -> usize

Convert to index.

fn from_index(index: usize) -> Option<Self> where
    Self: Sized, 

Convert form index.

unsafe fn from_index_unchecked(index: usize) -> Self

Convert form index.

fn foward(self) -> Self::Direction

To forward direction. It is nop when Axis is DIRECTED.

fn backward(self) -> Self::Direction

To backward direction. It reverses when Axis is DIRECTED.

fn from_direction(dir: Self::Direction) -> Self

Convert from direction.

const UNDIRECTED_COUNT: usize

Number of direction. If this axis is not directed, it is COUNT * 2, otherwise COUNT.

fn is_forward_direction(dir: &Self::Direction) -> bool

Check the direction is forward for this axis. Returns true if the direction is DIRECTED is true, or the index of the axis and direction matches.

impl Clone for AxisDR

fn clone(&self) -> AxisDR

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisDR

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

Formats the value using the given formatter.

impl From<AxisDR> for Direction

fn from(d: AxisDR) -> Self

Performs the conversion.

impl From<Direction> for AxisDR

fn from(d: Direction) -> Self

Performs the conversion.

impl Hash for AxisDR

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 Ord for AxisDR

fn cmp(&self, other: &AxisDR) -> 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 PartialEq<AxisDR> for AxisDR

fn eq(&self, other: &AxisDR) -> 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 PartialOrd<AxisDR> for AxisDR

fn partial_cmp(&self, other: &AxisDR) -> 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 Copy for AxisDR

impl Eq for AxisDR

impl StructuralEq for AxisDR

impl StructuralPartialEq for AxisDR