Struct SquareShape 

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

Shape for Square Graph.

Implementations

impl<E> SquareShape<E>

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

Create a new graph.

Trait Implementations

impl<E: Clone> Clone for SquareShape<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for SquareShape<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for SquareShape<E>

fn default() -> SquareShape<E>

Returns the “default value” for a type.

impl<E: Hash> Hash for SquareShape<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: Ord> Ord for SquareShape<E>

fn cmp(&self, other: &SquareShape<E>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<E: PartialEq> PartialEq for SquareShape<E>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<E: PartialOrd> PartialOrd for SquareShape<E>

fn partial_cmp(&self, other: &SquareShape<E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Shape for SquareShape

type Axis = SquareAxis

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 to_offset(&self, coord: Self::Coordinate) -> Result<Offset, ()>

Convert coordinate to Offset.

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

Convert coordinate to Offset without a check.

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

Convert coordinate from Offset.

fn horizontal(&self) -> usize

Horizontal node count.

fn vertical(&self) -> usize

Vertical node count.

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.

fn move_coord( &self, coord: SquareOffset, dir: DirectedSquareAxis, ) -> Result<SquareOffset, ()>

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 index_to_coordinate(&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.

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 SquareShape<Directed>

type Axis = DirectedSquareAxis

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.

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

Convert coordinate from Offset.

fn move_coord( &self, coord: Self::Coordinate, dir: DirectedSquareAxis, ) -> 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.

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

Convert coordinate to Offset without a check.

fn index_to_coordinate(&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 SquareShape<E>

impl<E: Eq> Eq for SquareShape<E>

impl<E> StructuralPartialEq for SquareShape<E>