Struct positioning::Position

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

Represents a position in a 3D grid, bounded in each dimension by the maximum size of an i64. Around the bounds, all arithmetic in this module with be done in a wrapping way, so be aware of that in your usage of this module.

Fields

x: i64

y: i64

z: i64

Implementations

impl Position

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

Creates a new Position.

pub fn is_adjacent_to(self, other: Position) -> bool

Returns whether or not we are adjacent to another position. Diagonal adjacency is not counted:

use positioning::Position;

assert!(!Position::new(0, 0, 0).is_adjacent_to(Position::new(1, 1, 0)))

pub fn adjacent(self) -> Box<dyn Iterator<Item = Position>>

Returns an iterator over all adjacent positions.

pub fn hamming_distance(self, other: Position) -> u64

Computes the Hamming distance between two points.

Trait Implementations

impl Add<Position> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, rhs: Position) -> Self::Output

Performs the + operation.

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 Debug for Position

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

Formats the value using the given formatter.

impl From<(i64, i64, i64)> for Position

fn from(triple: (i64, i64, i64)) -> Self

Converts to this type from the input type.

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.

impl Mul<i64> for Position

type Output = Position

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self::Output

Performs the * operation.

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.

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

Restrict a value to a certain interval.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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: &Rhs) -> bool

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

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

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

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

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

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

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

impl Sub<Position> for Position

type Output = Position

The resulting type after applying the - operator.

fn sub(self, rhs: Position) -> Self::Output

Performs the - operation.

impl Copy for Position

impl Eq for Position

impl StructuralEq for Position

impl StructuralPartialEq for Position