Struct gridd::Offset

pub struct Offset {
    pub col_offset: i32,
    pub row_offset: i32,
}

A two-dimensional offset vector used to relate grid elements spatially.

Fields

col_offset: i32

row_offset: i32

Methods

impl Offset

pub const NORTH: Offset

Northern unit vector: (col: +0, row: -1).

pub const EAST: Offset

Eastern unit vector: (col: +1, row: +0).

pub const SOUTH: Offset

Southern unit vector: (col: +0, row: +1).

pub const WEST: Offset

Western unit vector: (col: -1, row: +0).

pub fn cardinal_sum(n: i32, e: i32, s: i32, w: i32) -> Self

Create a new Offset from the sum of cardinal vectors.

Examples

use gridd::Offset;

assert_eq!(
    Offset::cardinal_sum(1, 0, -1, 0),
    Offset::NORTH - Offset::SOUTH
);

assert_eq!(
    Offset::cardinal_sum(0, 2, 0, 3),
    2 * Offset::EAST + 3 * Offset::WEST
);

pub fn rcoord(&self, (col, row): Coord) -> Option<Coord>

Get the coordinate pointed to by an Offset from a given Coord.

Returns None when either Coord component would be negative.

Examples

use gridd::{Coord, Offset};

let coord: Coord = (3, 5);

let v1 = Offset::from((-3, 2));
assert_eq!(Some((0, 7)), v1.rcoord(coord));

let v2 = Offset::from((-4, 5));
assert_eq!(None, v2.rcoord(coord));

Trait Implementations

impl Eq for Offset

impl Default for Offset

fn default() -> Offset

Returns the "default value" for a type.

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Offset> for Offset

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

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

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

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

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

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

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

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

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

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

impl Ord for Offset

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

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

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

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

This method tests for !=.

impl From<(i32, i32)> for Offset

fn from((c, r): (i32, i32)) -> Self

Performs the conversion.

impl Copy for Offset

impl Hash for Offset

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

impl Add<Offset> for Offset

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<Offset> for Offset

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Mul<i32> for Offset

type Output = Self

The resulting type after applying the * operator.

fn mul(self, scalar: i32) -> Self::Output

Performs the * operation.

impl Mul<Offset> for i32

type Output = Offset

The resulting type after applying the * operator.

fn mul(self, vec: Offset) -> Self::Output

Performs the * operation.

impl Debug for Offset

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

Formats the value using the given formatter.