Struct Point 

pub struct Point {
    pub x: i32,
    pub y: i32,
}

2D (grid) point with integer coordinates x and y. It has member functions for many common operations such as computing the manhattan distance as well as operator implementations for easy arithmetic.

Fields

x: i32

y: i32

Implementations

impl Point

pub fn new(x: i32, y: i32) -> Point

pub fn dir_obj(&self, other: &Point) -> Direction

Compares this to another point and gives the direction the other is in seen from this point.

pub fn dir(&self, other: &Point) -> Point

Like dir_obj but directly translates the Direction back to a point which can be used like a delta.

pub fn abs_dir(&self) -> Direction

Gives the direction in which the given point is as seen from the origin.

pub fn manhattan_distance(&self, other: &Point) -> i32

L-1 norm. As a grid-pathfinding heuristic it represents number of moves on a uniform cost 4-connected grid.

pub fn move_distance(&self, other: &Point) -> i32

L-inf norm. As a grid-pathfinding heuristic it represents number of moves on a uniform cost 8-connected grid.

pub fn euclidean_distance(&self, other: &Point) -> f32

L-2 norm.

pub fn moore_neighbor(&self, dir_num: i32) -> Point

Retrieves a single neighbour on an 8-connected grid, with the indexing used being similar to that in Direction.

pub fn neumann_neighborhood(&self) -> Vec<Point>

Neighbours on a 4-connected grid.

pub fn neumann_neighborhood_array(&self) -> [Point; 4]

Neighbours on a 4-connected grid.

pub fn moore_neighborhood(&self) -> Vec<Point>

Neighbours on an 8-connected grid.

pub fn moore_neighborhood_array(&self) -> [Point; 8]

Neighbours on an 8-connected grid.

pub fn general_moore_neighborhood(&self, size: i32) -> Vec<Point>

Alternative neighborhood, takes a square of a given size centered around self.

Trait Implementations

impl Add<Direction> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Point

Performs the + operation.

impl Add for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Point) -> Point

Performs the + operation.

impl Clone for Point

fn clone(&self) -> Point

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Point

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Point

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Point

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

Formats the value using the given formatter.

impl From<Direction> for Point

fn from(val: Direction) -> Self

Converts to this type from the input type.

impl Hash for Point

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 Mul<i32> for Point

type Output = Point

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Point

Performs the * operation.

impl Neg for Point

type Output = Point

The resulting type after applying the - operator.

fn neg(self) -> Point

Performs the unary - operation.

impl Ord for Point

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: Point) -> Point

Performs the - operation.

impl Copy for Point

impl Eq for Point

impl StructuralPartialEq for Point