Struct ingrid::Coordinate

pub struct Coordinate {
    pub x: usize,
    pub y: usize,
}

A two-dimensional coordinate

This structure defines a basic two-dimensional coordinate to index grids. It enables copy semantics to avoid handling ownership and references throughout your code for no significant performance. Also, in practice, you use the coord! macro helper to instantiate coordinates.

Examples

// Create a coordinate to index the top-left element of a grid.
let mut coord1 = coord!(0, 0);

// Copy the coordinate into another variable.
let coord2 = coord1;

// The first variable is still accessible.
coord1.x = 42;
coord1.y += 1;

// Additionally, you could also type the following.
let coord3 = Coordinate::zero();

Fields

x: usize

The coordinate on the X axis.

y: usize

The coordinate on the Y axis.

Methods

impl Coordinate

pub fn new(x: usize, y: usize) -> Coordinate

Construct a new coordinate.

This function constructs a new coordinate from given X and Y values.

Examples

let coord = Coordinate::new(0, 42);

assert_eq!(coord.x, 0);
assert_eq!(coord.y, 42);

pub fn zero() -> Coordinate

Construct a zero coordinate.

This function constructs a 'zero' coordinate which is a coordinate with both x and y values set at 0.

Examples

let coord = Coordinate::zero();

assert_eq!(coord.x, 0);
assert_eq!(coord.y, 0);

Trait Implementations

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Coordinate

impl Debug for Coordinate

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

Formats the value using the given formatter.

impl Eq for Coordinate

impl<T> Index<Coordinate> for Grid<T>

type Output = T

The returned type after indexing.

fn index(&self, coordinate: Coordinate) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Coordinate> for Grid<T>

fn index_mut(&mut self, coordinate: Coordinate) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq<Coordinate> for Coordinate

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

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

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

This method tests for !=.

impl StructuralEq for Coordinate

impl StructuralPartialEq for Coordinate