Struct Vector3

pub struct Vector3 {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

A point in 3-dimensional space

Fields

x: i32

y: i32

z: i32

Implementations

impl Vector3

pub fn new(x: i32, y: i32, z: i32) -> Vector3

pub fn abs_sum(self) -> i32

Return the manhattan distance of this vector from the origin

pub fn decr(self) -> Vector3

Return this point with all dimensions decremented by 1

pub fn incr(self) -> Vector3

Return this point with all dimensions incremented by 1

pub fn inclusive_range( min: Vector3, max: Vector3, ) -> impl Iterator<Item = Vector3>

Return all points that lie within the minimum and maximum bounds, inclusive

pub fn adjacent(self) -> impl Iterator<Item = Vector3>

Iterate over points in 3d space adjacent to this point

This includes diagonals, and excludes the center. It always returns 26 items.

pub fn boundary_min(self, other: Vector3) -> Vector3

Return the boundary minimum between self and other.

The standard .min function computes a total ordering between two vectors, but it doesn’t help for computing an inclusive range. For example, it is true that

let a = Vector3::new(-1, -1, -1);
let b = Vector3::new(0, -3, -1);
assert!(a < b);

The boundary minimum, on the other hand, computes the minimal bounded point which contains both self and other:

let a = Vector3::new(-1, -1, -1);
let b = Vector3::new(0, -3, -1);
assert_eq!(a.boundary_min(b), Vector3::new(-1, -3, -1));

pub fn boundary_max(self, other: Vector3) -> Vector3

Return the boundary maximum between self and other.

The standard .max function computes a total ordering between two vectors, but it doesn’t help for computing an inclusive range. For example, it is true that

let a = Vector3::new(1, 1, 1);
let b = Vector3::new(0, 3, 1);
assert!(a > b);

The boundary minimum, on the other hand, computes the minimal bounded point which contains both self and other:

let a = Vector3::new(1, 1, 1);
let b = Vector3::new(0, 3, 1);
assert_eq!(a.boundary_max(b), Vector3::new(1, 3, 1));

pub fn volume<T>(self) -> T

where T: From<i32> + Mul<Output = T>,

Return the volume of the space defined between this point and the origin.

Trait Implementations

impl Add for Vector3

type Output = Vector3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vector3

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Vector3

fn clone(&self) -> Vector3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector3

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

Formats the value using the given formatter.

impl Default for Vector3

fn default() -> Vector3

Returns the “default value” for a type.

impl Display for Vector3

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

Formats the value using the given formatter.

impl FromStr for Vector3

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Vector3

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Vector3

fn cmp(&self, other: &Vector3) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Vector3

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Vector3

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PointTrait for Vector3

type N = i32

Numeric type backing this point

fn manhattan(self) -> Self::N

Return the manhattan distance of this point from the origin.

fn decr(self) -> Self

Reduce all components of this point by 1.

fn incr(self) -> Self

Increase all components of this point by 1.

fn inclusive_range(min: Self, max: Self) -> Box<dyn Iterator<Item = Self>>

Generate all points inclusively bounded by min and max.

fn boundary_min(self, other: Self) -> Self

Return the boundary minimum between self and other.

fn boundary_max(self, other: Self) -> Self

Return the boundary maximum between self and other.

fn volume<T>(self) -> T

where T: From<Self::N> + Mul<Output = T>,

Return the volume of the space defined between this point and the origin.

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

where Self: 'static,

Iterate over points adjacent to this point.

impl Sub for Vector3

type Output = Vector3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vector3

fn sub_assign(&mut self, other: Vector3)

Performs the -= operation.

impl Copy for Vector3

impl Eq for Vector3

impl StructuralPartialEq for Vector3