Struct Coordinate 

pub struct Coordinate<T> {
    pub x: T,
    pub y: T,
}

A standard 2D Cartesian Coordinate

Fields

x: T

y: T

Implementations

impl<T: Copy + 'static> Coordinate<T>

pub fn from<U: AsPrimitive<T>>(other: Coordinate<U>) -> Coordinate<T>

impl<T: Integer + Copy> Coordinate<T>

pub fn neighbours(&self) -> Vec<Self>

All co-ordinates directly neighbouring the square on a grid, excluding diagonals

pub fn extended_neighbours(&self) -> Vec<Self>

All co-ordinates directly neighbouring the square on a grid, including diagonals

pub fn hex_neighbours(&self) -> Vec<Self>

Returns all co-ordinates directly neighbouring the square on an alternating hex grid:

  1 2
 3 X 4
  5 6

pub fn manhattan_distance(&self, other: &Self) -> T

Taxicab / manhattan distance: difference between X coordinates plus difference between Y coordinates

pub fn neighbour(&self, direction: Direction) -> Self

The neighbouring Coordinate in the supplied Direction

impl<T: Integer + Copy + CheckedSub + CheckedAdd + Unsigned> Coordinate<T>

pub fn checked_neighbour(&self, direction: Direction) -> Option<Self>

The neighbouring Coordinate in the supplied Direction, checked for under / overflow

pub fn checked_neighbours( &self, ) -> impl Iterator<Item = Coordinate<T>> + use<'_, T>

The neighbouring Coordinates in the four compass Directions, checked for under / overflow

pub fn checked_extended_neighbours( &self, ) -> impl Iterator<Item = Coordinate<T>> + use<'_, T>

The neighbouring Coordinates in the eight Directions, checked for under / overflow

Trait Implementations

impl<T: Add<Output = T>> Add for Coordinate<T>

type Output = Coordinate<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: AddAssign> AddAssign for Coordinate<T>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Unsigned + CheckedAdd<Output = T>> CheckedAdd for Coordinate<T>

fn checked_add(&self, other: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl<T: Unsigned + CheckedSub<Output = T>> CheckedSub for Coordinate<T>

fn checked_sub(&self, other: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl<T: Clone> Clone for Coordinate<T>

fn clone(&self) -> Coordinate<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Coordinate<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Coordinate<T>

Renders Coordinate as (x,y)

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Coordinate<T>

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<T> Mul<T> for Coordinate<T>

where T: Mul<Output = T> + Copy,

type Output = Coordinate<T>

The resulting type after applying the * operator.

fn mul(self, n: T) -> Coordinate<T>

Performs the * operation.

impl<T: Eq + PartialEq + Ord + Copy> Ord for Coordinate<T>

Y values are treated as more significant than X values; this preserves the reading order used in a number of puzzles.

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

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

where T: Copy + Ord + PartialOrd,

fn partial_cmp(&self, other: &Self) -> 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<T: Sub<Output = T>> Sub for Coordinate<T>

type Output = Coordinate<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign> SubAssign for Coordinate<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Copy> Copy for Coordinate<T>

impl<T: Eq> Eq for Coordinate<T>

impl<T> StructuralPartialEq for Coordinate<T>