Struct definitive::Vector

pub struct Vector<T = f32, const N: usize>(_);

A generic type representing an N dimensional vector

Methods

impl<T, const N: usize> Vector<T, { N }>

pub fn new(components: [T; { N }]) -> Self

Create a new vector out of some components

Note: Vector also implements From<[T, {N}]> which can be cleaner

pub fn resize_with<const M: usize>(
    self,
    fill: impl FnMut() -> T
) -> Vector<T, { M }>

Resize the vector to { M } length, either truncating or filling with fill

See also resize, resize_zero and resize_one for Vector<T, _>'s that have Default, Zero and One implementations, respectively

impl<T: Default, const N: usize> Vector<T, { N }>

pub fn resize<const M: usize>(self) -> Vector<T, { M }>

Resize the vector to { M } lenght, either truncating or filling with T::default

impl<T: One, const N: usize> Vector<T, { N }>

pub fn resize_one<const M: usize>(self) -> Vector<T, { M }>

Resize the vector to { M } lenght, either truncating or filling with T::one

impl<T: Zero, const N: usize> Vector<T, { N }>

pub fn resize_zero<const M: usize>(self) -> Vector<T, { M }>

Resize the vector to { M } lenght, either truncating or filling with T::one

impl<T: Mul<Output = T> + Add<Output = T> + Zero, const N: usize> Vector<T, { N }>

Requires T: Add + Mul + Zero

pub fn dot(self, rhs: Self) -> T

Calculate the dot product

A1 * B1 + A2 * B2 + ... + An * Bn

impl<T: Mul<Output = T> + Add<Output = T> + Clone + Zero, const N: usize> Vector<T, { N }>

Requires T: Add + Mul + Clone + Zero

pub fn length2(&self) -> T

Calculate the length of the vector and square it

A1^2 + A2^2 + ... + An^2

impl<T: Mul<Output = T> + Add<Output = T> + Clone + Zero + Sqrt, const N: usize> Vector<T, { N }>

Requires T: Add + Mul + Clone + Zero + Sqrt

pub fn length(&self) -> T

Calculate the length/magnitude of the vector

sqrt(A1^2 + A2^2 + ... + An^2)

impl<T: Mul<Output = T> + Div<Output = T> + Add<Output = T> + Clone + Zero + Sqrt, const N: usize> Vector<T, { N }>

Requires T: Add + Mul + Clone + Zero + Sqrt

pub fn normalize(self) -> Self

Normalize the vector, making its length one

Trait Implementations

impl<T: One, const N: usize> One for Vector<T, { N }>

fn one() -> Self

One value

impl<T: Zero, const N: usize> Zero for Vector<T, { N }>

fn zero() -> Self

Zero value

impl<T, const N: usize> From<[T; N]> for Vector<T, { N }>

fn from(v: [T; { N }]) -> Self

Performs the conversion.

impl<T: Clone, const N: usize> Clone for Vector<T, { N }>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, const N: usize> Copy for Vector<T, { N }>

impl<T: Eq, const N: usize> Eq for Vector<T, { N }>

impl<T: Tr, const N: usize> PartialEq<Vector<T, N>> for Vector<T, { N }>

fn eq(&self, rhs: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Debug, const N: usize> Debug for Vector<T, { N }>

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

Formats the value using the given formatter.

impl<T: Div<Output = T>, const N: usize> Div<Vector<T, N>> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Div<T, Output = T> + Clone, const N: usize> Div<T> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Rem<Output = T>, const N: usize> Rem<Vector<T, N>> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the % operator.

default fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<T: Rem<T, Output = T> + Clone, const N: usize> Rem<T> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: Sub<Output = T>, const N: usize> Sub<Vector<T, N>> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Sub<T, Output = T> + Clone, const N: usize> Sub<T> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Add<Output = T>, const N: usize> Add<Vector<T, N>> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Add<T, Output = T> + Clone, const N: usize> Add<T> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Mul<Output = T>, const N: usize> Mul<Vector<T, N>> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Mul<T, Output = T> + Clone, const N: usize> Mul<T> for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Neg<Output = T>, const N: usize> Neg for Vector<T, { N }>

type Output = Vector<T, { N }>

The resulting type after applying the - operator.

default fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: AddAssign, const N: usize> AddAssign<Vector<T, N>> for Vector<T, { N }>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: AddAssign<T> + Clone, const N: usize> AddAssign<T> for Vector<T, { N }>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T: SubAssign, const N: usize> SubAssign<Vector<T, N>> for Vector<T, { N }>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: SubAssign<T> + Clone, const N: usize> SubAssign<T> for Vector<T, { N }>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T: MulAssign, const N: usize> MulAssign<Vector<T, N>> for Vector<T, { N }>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: MulAssign<T> + Clone, const N: usize> MulAssign<T> for Vector<T, { N }>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: DivAssign, const N: usize> DivAssign<Vector<T, N>> for Vector<T, { N }>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T: DivAssign<T> + Clone, const N: usize> DivAssign<T> for Vector<T, { N }>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: RemAssign, const N: usize> RemAssign<Vector<T, N>> for Vector<T, { N }>

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<T: RemAssign<T> + Clone, const N: usize> RemAssign<T> for Vector<T, { N }>

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T, const N: usize> Deref for Vector<T, { N }>

type Target = [T; { N }]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, const N: usize> DerefMut for Vector<T, { N }>

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

Mutably dereferences the value.