Struct vectory::Vec2

#[repr(C)]pub struct Vec2<T>(_, _);

A generic 2D vector type that represented by tuple struct.

Implementations

impl<T> Vec2<T>

pub const LANES: usize

The number of lanes in this vector.

pub fn new(a0: T, a1: T) -> Self

Constructs a new vector with the given values.

pub fn splat(value: T) -> Self where
    T: Copy, 

Construct a new vector by setting each of its element to the given value.

pub fn unit_0() -> Vec2<T> where
    T: Copy + One + Zero, 

Returns a unit vector which points along the 0 axis.

pub fn unit_1() -> Vec2<T> where
    T: Copy + One + Zero, 

Returns a unit vector which points along the 1 axis.

pub fn as_slice(&self) -> &[T]

Views this vector as an immutable slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

Views this vector as a mutable slice.

pub fn sum(self) -> T where
    T: Add<Output = T>, 

Returns the sum of all elements in this vector.

pub fn product(self) -> T where
    T: Mul<Output = T>, 

Returns the product of all elements in this vector.

pub fn dot(self, other: Self) -> T where
    T: Add<Output = T> + Mul<Output = T>, 

Returns the dot product between self and other.

pub fn length_squared(self) -> T where
    T: Copy + Add<Output = T> + Mul<Output = T>, 

Returns the sqaured length of this vector.

pub fn length(self) -> T where
    T: Copy + Real + Add<Output = T> + Mul<Output = T>, 

Returns the length of this vector.

pub fn length_recip(self) -> T where
    T: Copy + One + Real + Add<Output = T> + Mul<Output = T>, 

Returns the reciprocal of its length.

Panics

Panics if self is of length zero.

pub fn distance_squared(self, other: Self) -> T where
    T: Copy + Real + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

Returns the squared euclidean distance between two points.

pub fn distance(self, other: Self) -> T where
    T: Copy + Real + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

Returns the euclidean distance between two points.

pub fn min(self, other: Self) -> Self where
    T: Copy + PartialOrd, 

Returns a vector containing the mininum values for each elements of self and other.

pub fn max(self, other: Self) -> Self where
    T: Copy + PartialOrd, 

Returns a vector containing the maximun values for each elements of self and other.

pub fn min_elem(self) -> T where
    T: Copy + PartialOrd, 

Returns the smallest element in this vector.

pub fn max_elem(self) -> T where
    T: Copy + PartialOrd, 

Returns the largest element in this vector.

pub fn map<M, F>(self, f: F) -> Vec2<M> where
    F: FnMut(T) -> M, 

Returns an vector of the same shape as self, with function f applied to each element in order.

pub fn apply<F>(&mut self, f: F) where
    T: Copy,
    F: FnMut(T) -> T, 

Applies the function f to each element in order, in-place.

pub fn abs(self) -> Self where
    T: Signed, 

Computes the absolute value of self.

pub fn normalize(self) -> Self where
    T: Add<Output = T> + Real + One, 

Returns a normalized self whose length is equal to 1.

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

Restricts each element in self to a certain interval given by the corresponing element in min and max.

Panics

For each corresponing element in min and max, panics if min > max, min is NaN, or max is NaN.

pub fn is_nan(self) -> bool where
    T: Float, 

Returns true if any elements are NaN.

Trait Implementations

impl<T> Add<Vec2<T>> for Vec2<T> where
    T: Add<T, Output = T>, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vec2<f32>> for f32

type Output = Vec2<f32>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<f32>) -> Self::Output

Performs the + operation.

impl Add<Vec2<f64>> for f64

type Output = Vec2<f64>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<f64>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i128>> for i128

type Output = Vec2<i128>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i128>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i16>> for i16

type Output = Vec2<i16>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i16>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i32>> for i32

type Output = Vec2<i32>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i32>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i64>> for i64

type Output = Vec2<i64>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i64>) -> Self::Output

Performs the + operation.

impl Add<Vec2<i8>> for i8

type Output = Vec2<i8>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<i8>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u128>> for u128

type Output = Vec2<u128>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u128>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u16>> for u16

type Output = Vec2<u16>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u16>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u32>> for u32

type Output = Vec2<u32>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u32>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u64>> for u64

type Output = Vec2<u64>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u64>) -> Self::Output

Performs the + operation.

impl Add<Vec2<u8>> for u8

type Output = Vec2<u8>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<u8>) -> Self::Output

Performs the + operation.

impl<T> AddAssign<Vec2<T>> for Vec2<T> where
    T: AddAssign<T>, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T> AsMut<[T]> for Vec2<T>

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl<T> AsMut<Vec2<T>> for Vec2<T>

fn as_mut(&mut self) -> &mut Self

Performs the conversion.

impl<T> AsRef<[T]> for Vec2<T>

fn as_ref(&self) -> &[T]

Performs the conversion.

impl<T> AsRef<Vec2<T>> for Vec2<T>

fn as_ref(&self) -> &Self

Performs the conversion.

impl<T> Borrow<[T]> for Vec2<T>

fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<T> BorrowMut<[T]> for Vec2<T>

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value.

impl<T: Clone> Clone for Vec2<T>

fn clone(&self) -> Vec2<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Vec2<T>

impl<T> Deref for Vec2<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Vec2<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Div<T> for Vec2<T> where
    T: Copy + Mul<Output = T> + Div<Output = T> + One, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T> Div<Vec2<T>> for Vec2<T> where
    T: Div<T, Output = T>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for Vec2<T> where
    T: Copy + Div<Output = T> + Mul<Output = T> + MulAssign + One, 

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> DivAssign<Vec2<T>> for Vec2<T> where
    T: DivAssign<T>, 

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T> From<[T; 2]> for Vec2<T>

fn from(array: [T; 2]) -> Self

Performs the conversion.

impl<T> From<(T, T)> for Vec2<T>

fn from(tuple: (T, T)) -> Self

Performs the conversion.

impl<T> From<T> for Vec2<T> where
    T: Copy, 

fn from(inner: T) -> Self

Performs the conversion.

impl<T> Into<[T; 2]> for Vec2<T>

fn into(self) -> [T; 2]

Performs the conversion.

impl<T> Into<(T, T)> for Vec2<T>

fn into(self) -> (T, T)

Performs the conversion.

impl<T> Mul<T> for Vec2<T> where
    T: Copy + Mul<Output = T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<Vec2<T>> for Vec2<T> where
    T: Mul<T, Output = T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2<f32>> for f32

type Output = Vec2<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<f32>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<f64>> for f64

type Output = Vec2<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<f64>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i128>> for i128

type Output = Vec2<i128>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i128>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i16>> for i16

type Output = Vec2<i16>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i16>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i32>> for i32

type Output = Vec2<i32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i32>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<i64>> for i64

type Output = Vec2<i64>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec2<i8>> for i8

type Output = Vec2<i8>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<i8>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u128>> for u128

type Output = Vec2<u128>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u128>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u16>> for u16

type Output = Vec2<u16>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u16>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u32>> for u32

type Output = Vec2<u32>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u32>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u64>> for u64

type Output = Vec2<u64>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u64>) -> Self::Output

Performs the * operation.

impl Mul<Vec2<u8>> for u8

type Output = Vec2<u8>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<u8>) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for Vec2<T> where
    T: Copy + MulAssign, 

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T> MulAssign<Vec2<T>> for Vec2<T> where
    T: MulAssign<T>, 

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T> Neg for Vec2<T> where
    T: Neg<Output = T>, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: PartialEq> PartialEq<Vec2<T>> for Vec2<T>

fn eq(&self, other: &Vec2<T>) -> bool

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

fn ne(&self, other: &Vec2<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for Vec2<T>

impl<T> Sub<Vec2<T>> for Vec2<T> where
    T: Sub<T, Output = T>, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<Vec2<T>> for Vec2<T> where
    T: SubAssign<T>, 

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.