Trait lattice_graph::lattice_abstract::shapes::Axis

pub trait Axis: Copy + PartialEq {
    type Direction: AxisDirection;

    const COUNT: usize;
    const DIRECTED: bool;
    const UNDIRECTED_COUNT: usize;

    fn to_index(&self) -> usize;
    fn from_index(index: usize) -> Option<Self>
    where
        Self: Sized;
    fn foward(self) -> Self::Direction;
    fn backward(self) -> Self::Direction;
    fn from_direction(dir: Self::Direction) -> Self;

    unsafe fn from_index_unchecked(index: usize) -> Self { ... }
    fn is_forward_direction(dir: &Self::Direction) -> bool { ... }
}

Axis of the graph. It holds what direction of edge which node has.

Associated Types

type Direction: AxisDirection

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

Associated Constants

const COUNT: usize

Number of axis.

const DIRECTED: bool

Whether it is Directed or not.

const UNDIRECTED_COUNT: usize

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

Required methods

fn to_index(&self) -> usize

Convert to index.

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

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.

Provided methods

unsafe fn from_index_unchecked(index: usize) -> Self

Convert form index.

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.

Implementors

impl Axis for AxisDQ

const COUNT: usize

const DIRECTED: bool

type Direction = Self

impl Axis for AxisDR

const COUNT: usize

const DIRECTED: bool

type Direction = Self

impl Axis for AxisQ

const COUNT: usize

const DIRECTED: bool

type Direction = AxisDQ

impl Axis for AxisR

const COUNT: usize

const DIRECTED: bool

type Direction = AxisDR

impl Axis for DirectedSquareAxis

const COUNT: usize

const DIRECTED: bool

type Direction = Self

impl Axis for DirectedSquareDiagonalAxis

const COUNT: usize

const DIRECTED: bool

const UNDIRECTED_COUNT: usize

type Direction = Self

impl Axis for SquareAxis

const COUNT: usize

const DIRECTED: bool

type Direction = DirectedSquareAxis

const UNDIRECTED_COUNT: usize

impl Axis for SquareDiagonalAxis

const COUNT: usize

const DIRECTED: bool

const UNDIRECTED_COUNT: usize

type Direction = DirectedSquareDiagonalAxis