Struct lattice_graph::lattice_abstract::square::SquareDiagonalShape

pub struct SquareDiagonalShape<E = Undirected> { /* private fields */ }

Shape for lattice graph with Square and Diagonal Edge.

Implementations

impl<E> SquareDiagonalShape<E>

pub fn new(h: usize, v: usize) -> Self

Create a new graph.

Trait Implementations

impl<E: Clone> Clone for SquareDiagonalShape<E>

fn clone(&self) -> SquareDiagonalShape<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for SquareDiagonalShape<E>

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

Formats the value using the given formatter.

impl<E: Hash> Hash for SquareDiagonalShape<E>

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<E: PartialEq> PartialEq<SquareDiagonalShape<E>> for SquareDiagonalShape<E>

fn eq(&self, other: &SquareDiagonalShape<E>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SquareDiagonalShape<E>) -> bool

This method tests for !=.

impl Shape for SquareDiagonalShape

type Axis = SquareDiagonalAxis

Axis of the lattice.

type Coordinate = SquareOffset

Coordinate of the lattice graph.

type OffsetConvertError = ()

Error to return when to_offset fails. Should set Infallible when the graph is looped and never to fail.

type CoordinateMoveError = ()

Error to return when move_coord fails. Should set Infallible when the graph is looped and never to fail.

fn horizontal(&self) -> usize

Horizontal node count.

fn vertical(&self) -> usize

Vertical node count.

fn to_offset(
    &self,
    coord: Self::Coordinate
) -> Result<Offset, Self::OffsetConvertError>

Convert coordinate to Offset.

unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset

Convert coordinate to Offset without a check.

fn from_offset(&self, offset: Offset) -> Self::Coordinate

Convert coordinate from Offset.

fn move_coord(
    &self,
    coord: Self::Coordinate,
    dir: DirectedSquareDiagonalAxis
) -> Result<Self::Coordinate, Self::CoordinateMoveError>

Move coordinates to the next coordinate in the direction. Coordinate should be a valid coordinate and should be checked before using move_coord. This is because the target coordinate might be valid even thought the souce coord is invalid, and some code validate the direction by moveing the coord.

fn node_count(&self) -> usize

Node count.

fn from_index(&self, index: usize) -> Self::Coordinate

Convert coordinate from index.

fn to_index(&self, coord: Self::Coordinate) -> Option<usize>

Covert coordinate to index.

fn index_to_offset(&self, index: usize) -> Offset

Convert index to offset.

fn offset_to_index(&self, o: Offset) -> usize

Covert offset to index.

fn horizontal_edge_size(&self, _axis: Self::Axis) -> usize

👎 Deprecated

Edge count of horizontal. May differ by the axis info.

fn vertical_edge_size(&self, _axis: Self::Axis) -> usize

👎 Deprecated

Edge count of vertical. May differ by the axis info.

unsafe fn move_coord_unchecked(
    &self,
    coord: Self::Coordinate,
    dir: <Self::Axis as Axis>::Direction
) -> Self::Coordinate

Move coordinates to the next coordinate in the direction. Caller should be sure that the source and the target coord is valid coord.

fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool

Check whether two coordinate is in neighbor.

fn get_direction(
    &self,
    source: Self::Coordinate,
    target: Self::Coordinate
) -> Option<<Self::Axis as Axis>::Direction>

Get direction if two coordiante is in neighbor.

impl Shape for SquareDiagonalShape<Directed>

type Axis = DirectedSquareDiagonalAxis

Axis of the lattice.

type Coordinate = SquareOffset

Coordinate of the lattice graph.

type OffsetConvertError = ()

Error to return when to_offset fails. Should set Infallible when the graph is looped and never to fail.

type CoordinateMoveError = ()

Error to return when move_coord fails. Should set Infallible when the graph is looped and never to fail.

fn horizontal(&self) -> usize

Horizontal node count.

fn vertical(&self) -> usize

Vertical node count.

fn to_offset(
    &self,
    coord: Self::Coordinate
) -> Result<Offset, Self::OffsetConvertError>

Convert coordinate to Offset.

unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset

Convert coordinate to Offset without a check.

fn from_offset(&self, offset: Offset) -> Self::Coordinate

Convert coordinate from Offset.

fn move_coord(
    &self,
    coord: Self::Coordinate,
    dir: DirectedSquareDiagonalAxis
) -> Result<Self::Coordinate, Self::CoordinateMoveError>

Move coordinates to the next coordinate in the direction. Coordinate should be a valid coordinate and should be checked before using move_coord. This is because the target coordinate might be valid even thought the souce coord is invalid, and some code validate the direction by moveing the coord.

fn node_count(&self) -> usize

Node count.

fn from_index(&self, index: usize) -> Self::Coordinate

Convert coordinate from index.

fn to_index(&self, coord: Self::Coordinate) -> Option<usize>

Covert coordinate to index.

fn index_to_offset(&self, index: usize) -> Offset

Convert index to offset.

fn offset_to_index(&self, o: Offset) -> usize

Covert offset to index.

fn horizontal_edge_size(&self, _axis: Self::Axis) -> usize

👎 Deprecated

Edge count of horizontal. May differ by the axis info.

fn vertical_edge_size(&self, _axis: Self::Axis) -> usize

👎 Deprecated

Edge count of vertical. May differ by the axis info.

unsafe fn move_coord_unchecked(
    &self,
    coord: Self::Coordinate,
    dir: <Self::Axis as Axis>::Direction
) -> Self::Coordinate

Move coordinates to the next coordinate in the direction. Caller should be sure that the source and the target coord is valid coord.

fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool

Check whether two coordinate is in neighbor.

fn get_direction(
    &self,
    source: Self::Coordinate,
    target: Self::Coordinate
) -> Option<<Self::Axis as Axis>::Direction>

Get direction if two coordiante is in neighbor.

impl<E: Copy> Copy for SquareDiagonalShape<E>

impl<E: Eq> Eq for SquareDiagonalShape<E>

impl<E> StructuralEq for SquareDiagonalShape<E>

impl<E> StructuralPartialEq for SquareDiagonalShape<E>