Struct smeagol::Position

pub struct Position {
    pub x: i64,
    pub y: i64,
}

The position of a cell in a Life grid.

Fields

x: i64

The x coordinate.

y: i64

The y coordinate.

Methods

impl Position

pub fn new(x: i64, y: i64) -> Self

Creates a new position with the given coordinates.

Exampes

let position = smeagol::Position::new(1, 2);

pub fn offset(&self, x_offset: i64, y_offset: i64) -> Self

Offsets the position by the given amounts in the x and y directions.

Examples

let pos = smeagol::Position::new(1, 2);
assert_eq!(pos.offset(3, 4), smeagol::Position::new(4, 6));

pub fn quadrant(&self) -> Quadrant

Returns which quadrant of a node the position is in.

Examples

assert_eq!(
    smeagol::Position::new(-1, -1).quadrant(),
    smeagol::node::Quadrant::Northwest
);
assert_eq!(
    smeagol::Position::new(-1, 0).quadrant(),
    smeagol::node::Quadrant::Southwest
);
assert_eq!(
    smeagol::Position::new(0, -1).quadrant(),
    smeagol::node::Quadrant::Northeast
);
assert_eq!(
    smeagol::Position::new(0, 0).quadrant(),
    smeagol::node::Quadrant::Southeast
);

Trait Implementations

impl PartialEq<Position> for Position

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

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

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

This method tests for !=.

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Position> for Position

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

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

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

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

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

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

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

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

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

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

impl Eq for Position

impl Ord for Position

fn cmp(&self, other: &Position) -> 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.

impl Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Hash for Position

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, 

Feeds a slice of this type into the given [Hasher].