Struct gridly::vector::Vector

pub struct Vector {
    pub rows: Rows,
    pub columns: Columns,
}

A measurement of distance between two [Location]s

A vector is the measurement of distance between two [Location]s. It supports arithmetic operations with itself, as well as anything which can be converted into a Vector. Currently, Rows, Columns, and Direction all have this property, as well as a tuple of (Into, Into).

Fields

rows: Rows

columns: Columns

Methods

impl Vector

pub fn new(rows: impl Into<Rows>, columns: impl Into<Columns>) -> Self

Create a new Vector

pub fn zero() -> Vector

Create a zero Vector

pub fn upward(size: isize) -> Vector

Create an upward pointing vector of the given size

pub fn downward(size: isize) -> Vector

Create a downward pointing vector of the given size

pub fn leftward(size: isize) -> Vector

Create a leftward pointing vector of the given size

pub fn rightward(size: isize) -> Vector

Create a rightward pointing vector of the given size

pub fn in_direction(direction: Direction, length: isize) -> Vector

Create a vector of the given size in the given direction

pub fn manhattan_length(&self) -> isize

Return the Manhattan length of the vector

The Manhattan length of a vector is the sum of the absolute values of its components

pub fn clockwise(&self) -> Vector

Return a new vector, rotated 90 degrees clockwise.

pub fn counterclockwise(&self) -> Vector

Return a new vector, rotated 90 degrees counterclockwise.

pub fn reverse(&self) -> Vector

pub fn get_component<T: Component>(&self) -> T

Generically get either the Rows or Columns of a vector

pub fn transpose(&self) -> Vector

Swap the rows and columns of this Vector

Trait Implementations

impl Clone for Vector

fn clone(&self) -> Vector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Vector

impl Copy for Vector

impl PartialEq<Vector> for Vector

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

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

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

This method tests for !=.

impl Default for Vector

fn default() -> Vector

Returns the "default value" for a type.

impl<C: Component> From<C> for Vector

Convert a Rows or Columns into an equivelent Vector

fn from(distance: C) -> Self

Performs the conversion.

impl From<Direction> for Vector

Convert a Direction into a unit vector pointing in that direction

fn from(direction: Direction) -> Self

Performs the conversion.

impl<R: Into<Rows>, C: Into<Columns>> From<(R, C)> for Vector

fn from(value: (R, C)) -> Vector

Performs the conversion.

impl Debug for Vector

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

Formats the value using the given formatter.

impl Hash for Vector

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

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

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

impl<T: Into<Vector>> Add<T> for Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Vector

Performs the + operation.

impl<T: Into<Vector>> Sub<T> for Vector

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Vector

Performs the - operation.

impl<T: Copy> Mul<T> for Vector where
    isize: Mul<T, Output = isize>, 

Multiply a vector's components by a constant factor

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, factor: T) -> Vector

Performs the * operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Vector

Performs the unary - operation.

impl<T: Into<Vector>> AddAssign<T> for Vector

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T: Into<Vector>> SubAssign<T> for Vector

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T: Copy> MulAssign<T> for Vector where
    isize: MulAssign<T>, 

Multiply a vector's components by a constant factor in-place

fn mul_assign(&mut self, factor: T)

Performs the *= operation.