Struct grid_search_cardinal::Coord

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

General purpose coordinate

Fields

x: i32

y: i32

Methods

impl Coord

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

pub fn from_size(size: Size) -> Result<Coord, DimensionTooLargeForCoord>

pub fn to_size(self) -> Result<Size, NegativeDimension>

pub fn normalize(self, size: Size) -> Coord

pub fn is_valid(self, size: Size) -> bool

pub fn get(self, axis: Axis) -> i32

pub fn get_mut(&mut self, axis: Axis) -> &mut i32

pub fn with_axis<F>(self, axis: Axis, f: F) -> Coord where
    F: FnMut(i32) -> i32, 

pub fn set(self, axis: Axis, value: i32) -> Coord

pub fn set_in_place(&mut self, axis: Axis, value: i32)

pub fn new_axis(this_axis: i32, other_axis: i32, axis: Axis) -> Coord

pub fn get_static<A>(self) -> i32 where
    A: StaticAxis, 

pub fn get_static_mut<A>(&mut self) -> &mut i32 where
    A: StaticAxis, 

pub fn with_static_axis<A, F>(self, f: F) -> Coord where
    A: StaticAxis,
    F: FnMut(i32) -> i32, 

pub fn set_static<A>(self, value: i32) -> Coord where
    A: StaticAxis, 

pub fn set_static_in_place<A>(&mut self, value: i32) where
    A: StaticAxis, 

pub fn new_static_axis<A>(this_axis: i32, other_axis: i32) -> Coord where
    A: StaticAxis, 

pub fn set_x(self, x: i32) -> Coord

pub fn set_y(self, y: i32) -> Coord

pub fn set_x_in_place(&mut self, x: i32)

pub fn set_y_in_place(&mut self, y: i32)

pub fn checked_add(self, rhs: Coord) -> Option<Coord>

pub fn checked_sub(self, rhs: Coord) -> Option<Coord>

pub fn checked_mul(self, rhs: i32) -> Option<Coord>

pub fn checked_div(self, rhs: i32) -> Option<Coord>

pub const fn magnitude2(self) -> u32

pub const fn distance2(self, other: Coord) -> u32

pub const fn manhattan_magnitude(self) -> u32

pub const fn manhattan_distance(self, other: Coord) -> u32

pub const fn opposite(self) -> Coord

pub const fn left90(self) -> Coord

pub const fn right90(self) -> Coord

pub const fn cardinal_left45(self) -> Coord

pub const fn cardinal_right45(self) -> Coord

pub const fn cardinal_left135(self) -> Coord

pub const fn cardinal_right135(self) -> Coord

Trait Implementations

impl Debug for Coord

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

Formats the value using the given formatter.

impl Mul<i32> for Coord

type Output = Coord

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> <Coord as Mul<i32>>::Output

Performs the * operation.

impl<'a> Mul<i32> for &'a Coord

type Output = Coord

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> <&'a Coord as Mul<i32>>::Output

Performs the * operation.

impl StructuralEq for Coord

impl Default for Coord

fn default() -> Coord

Returns the "default value" for a type.

impl PartialOrd<Coord> for Coord

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> AddAssign<T> for Coord where
    Coord: Add<T>,
    <Coord as Add<T>>::Output == Coord, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Eq for Coord

impl From<[i32; 2]> for Coord

fn from(array: [i32; 2]) -> Coord

Performs the conversion.

impl From<(i32, i32)> for Coord

fn from((i32, i32)) -> Coord

Performs the conversion.

impl Div<i32> for Coord

type Output = Coord

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> <Coord as Div<i32>>::Output

Performs the / operation.

impl<'a> Div<i32> for &'a Coord

type Output = Coord

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> <&'a Coord as Div<i32>>::Output

Performs the / operation.

impl<T> MulAssign<T> for Coord where
    Coord: Mul<T>,
    <Coord as Mul<T>>::Output == Coord, 

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl StructuralPartialEq for Coord

impl Copy for Coord

impl<'a, 'b> Add<&'a Coord> for &'b Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, &'a Coord) -> <&'b Coord as Add<&'a Coord>>::Output

Performs the + operation.

impl Add<Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, Coord) -> <Size as Add<Coord>>::Output

Performs the + operation.

impl<'a> Add<Size> for &'a Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: Size) -> <&'a Coord as Add<Size>>::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Size> for &'b Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: &'a Size) -> <&'b Coord as Add<&'a Size>>::Output

Performs the + operation.

impl<'a> Add<&'a Coord> for Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, &'a Coord) -> <Size as Add<&'a Coord>>::Output

Performs the + operation.

impl<'a, 'b> Add<&'a Coord> for &'b Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, &'a Coord) -> <&'b Size as Add<&'a Coord>>::Output

Performs the + operation.

impl<'a> Add<&'a Coord> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, &'a Coord) -> <Coord as Add<&'a Coord>>::Output

Performs the + operation.

impl Add<Size> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: Size) -> <Coord as Add<Size>>::Output

Performs the + operation.

impl<'a> Add<&'a Size> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, size: &'a Size) -> <Coord as Add<&'a Size>>::Output

Performs the + operation.

impl<'a> Add<Coord> for &'a Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, Coord) -> <&'a Coord as Add<Coord>>::Output

Performs the + operation.

impl<'a> Add<Coord> for &'a Size

type Output = Coord

The resulting type after applying the + operator.

fn add(self, Coord) -> <&'a Size as Add<Coord>>::Output

Performs the + operation.

impl Add<Coord> for Coord

type Output = Coord

The resulting type after applying the + operator.

fn add(self, Coord) -> <Coord as Add<Coord>>::Output

Performs the + operation.

impl Sub<Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, Coord) -> <Size as Sub<Coord>>::Output

Performs the - operation.

impl<'a> Sub<&'a Coord> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, &'a Coord) -> <Coord as Sub<&'a Coord>>::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Coord> for &'b Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, &'a Coord) -> <&'b Coord as Sub<&'a Coord>>::Output

Performs the - operation.

impl Sub<Coord> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, Coord) -> <Coord as Sub<Coord>>::Output

Performs the - operation.

impl<'a> Sub<&'a Coord> for Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, &'a Coord) -> <Size as Sub<&'a Coord>>::Output

Performs the - operation.

impl<'a> Sub<Size> for &'a Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: Size) -> <&'a Coord as Sub<Size>>::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Coord> for &'b Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, &'a Coord) -> <&'b Size as Sub<&'a Coord>>::Output

Performs the - operation.

impl<'a> Sub<Coord> for &'a Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, Coord) -> <&'a Coord as Sub<Coord>>::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a Size> for &'b Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: &'a Size) -> <&'b Coord as Sub<&'a Size>>::Output

Performs the - operation.

impl Sub<Size> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: Size) -> <Coord as Sub<Size>>::Output

Performs the - operation.

impl<'a> Sub<Coord> for &'a Size

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, Coord) -> <&'a Size as Sub<Coord>>::Output

Performs the - operation.

impl<'a> Sub<&'a Size> for Coord

type Output = Coord

The resulting type after applying the - operator.

fn sub(self, size: &'a Size) -> <Coord as Sub<&'a Size>>::Output

Performs the - operation.

impl<T> SubAssign<T> for Coord where
    Coord: Sub<T>,
    <Coord as Sub<T>>::Output == Coord, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl PartialEq<Coord> for Coord

fn eq(&self, other: &Coord) -> bool

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

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

This method tests for !=.

impl Ord for Coord

fn cmp(&self, other: &Coord) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Clone for Coord

fn clone(&self) -> Coord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> DivAssign<T> for Coord where
    Coord: Div<T>,
    <Coord as Div<T>>::Output == Coord, 

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl Hash for Coord

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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].