Struct vectrs::Vector

pub struct Vector<T, const N: usize> { /* fields omitted */ }

Represents a constant-size, n-dimensional vector.

See the crate root for usage examples.

Implementations

impl<T: Num, const N: usize> Vector<T, N> where
    Self: X, 

pub fn x(&self) -> T

Returns this component of the vector.

pub fn x_ref(&self) -> &T

Returns a reference to this component of the vector.

pub fn x_mut(&mut self) -> &mut T

Returns a mutable reference to this component of the vector.

impl<T: Num, const N: usize> Vector<T, N> where
    Self: Y, 

pub fn y(&self) -> T

Returns this component of the vector.

pub fn y_ref(&self) -> &T

Returns a reference to this component of the vector.

pub fn y_mut(&mut self) -> &mut T

Returns a mutable reference to this component of the vector.

impl<T: Num, const N: usize> Vector<T, N> where
    Self: Z, 

pub fn z(&self) -> T

Returns this component of the vector.

pub fn z_ref(&self) -> &T

Returns a reference to this component of the vector.

pub fn z_mut(&mut self) -> &mut T

Returns a mutable reference to this component of the vector.

impl<T: Num, const N: usize> Vector<T, N> where
    Self: W, 

pub fn w(&self) -> T

Returns this component of the vector.

pub fn w_ref(&self) -> &T

Returns a reference to this component of the vector.

pub fn w_mut(&mut self) -> &mut T

Returns a mutable reference to this component of the vector.

impl<T: Num, const N: usize> Vector<T, N>

pub fn zero() -> Self

Returns a zero vector.

pub fn from_partial<U>(partial: U) -> Self where
    Self: FromPartial<T, U>, 

Create a vector from various types, filling with zeroes as needed.

pub fn from_partial_with<U>(partial: U, fill: T) -> Self where
    Self: FromPartial<T, U>, 

Create a vector from various types, filling with the given value as needed.

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

Views the underlying vector representation as a slice.

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

Views the underlying vector representation as a mutable slice.

pub fn abs(self) -> Self

Returns the absolute value of the vector.

pub fn reduced(self) -> Self

Returns the reduced row echelon form of the vector.

This is the same as dividing each element by the greatest common divisor of all the elements.

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

Calculates the dot-product between self and other.

pub fn l1_norm(&self) -> T

Returns the L1 norm of the vector.

Also known as Manhattan Distance or Taxicab norm. L1 Norm is the sum of the magnitudes of the vectors in a space.

Trait Implementations

impl<T: Num, const N: usize, '_> Add<&'_ Vector<T, N>> for Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the + operator.

pub fn add(self, other: &Vector<T, N>) -> Self::Output

Performs the + operation.

impl<T: Num, const N: usize, '_, '_> Add<&'_ Vector<T, N>> for &'_ Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the + operator.

pub fn add(self, other: &Vector<T, N>) -> Self::Output

Performs the + operation.

impl<T: Num, const N: usize> Add<Vector<T, N>> for Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the + operator.

pub fn add(self, other: Vector<T, N>) -> Self::Output

Performs the + operation.

impl<T: Num, const N: usize, '_> AddAssign<&'_ Vector<T, N>> for Vector<T, N>

pub fn add_assign(&mut self, other: &Vector<T, N>)

Performs the += operation.

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

pub fn add_assign(&mut self, other: Vector<T, N>)

Performs the += operation.

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

pub fn clone(&self) -> Vector<T, N>

Returns a copy of the value.

pub 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: Debug, const N: usize> Debug for Vector<T, N>

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

Formats the value using the given formatter.

impl<T: Num, const N: usize> Default for Vector<T, N>

pub fn default() -> Self

Returns the "default value" for a type.

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

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

impl<'a, T: Num, const N: usize> From<&'a [T]> for Vector<T, N>

pub fn from(slice: &'a [T]) -> Self

Performs the conversion.

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

pub fn from(arr: [T; N]) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T, T, T, T, T, T, T)> for Vector<T, 12>

pub fn from(
    (x, y, z, w, a, b, c, d, e, f, g, h): (T, T, T, T, T, T, T, T, T, T, T, T)
) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T, T, T, T, T, T)> for Vector<T, 11>

pub fn from(
    (x, y, z, w, a, b, c, d, e, f, g): (T, T, T, T, T, T, T, T, T, T, T)
) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T, T, T, T, T)> for Vector<T, 10>

pub fn from(
    (x, y, z, w, a, b, c, d, e, f): (T, T, T, T, T, T, T, T, T, T)
) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T, T, T, T)> for Vector<T, 9>

pub fn from((x, y, z, w, a, b, c, d, e): (T, T, T, T, T, T, T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T, T, T)> for Vector<T, 8>

pub fn from((x, y, z, w, a, b, c, d): (T, T, T, T, T, T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T, T)> for Vector<T, 7>

pub fn from((x, y, z, w, a, b, c): (T, T, T, T, T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T, T)> for Vector<T, 6>

pub fn from((x, y, z, w, a, b): (T, T, T, T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T, T)> for Vector<T, 5>

pub fn from((x, y, z, w, a): (T, T, T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T, T, T)> for Vector<T, 4>

pub fn from((x, y, z, w): (T, T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T, T)> for Vector<T, 3>

pub fn from((x, y, z): (T, T, T)) -> Self

Performs the conversion.

impl<T> From<(T, T)> for Vector<T, 2>

pub fn from((x, y): (T, T)) -> Self

Performs the conversion.

impl<T> From<(T,)> for Vector<T, 1>

pub fn from((x): (T,)) -> Self

Performs the conversion.

impl<T: Num, const N: usize> From<Vec<T, Global>> for Vector<T, N>

pub fn from(vec: Vec<T>) -> Self

Performs the conversion.

impl<T: Num, const N: usize> FromIterator<T> for Vector<T, N>

pub fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, T: Num, const N: usize> FromPartial<T, &'a [T]> for Vector<T, N>

pub fn from_partial(slice: &'a [T], fill: T) -> Self

impl<T: Num, const M: usize, const N: usize> FromPartial<T, [T; M]> for Vector<T, N>

pub fn from_partial(arr: [T; M], fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T, T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial(
    (x, y, z, w, a, b, c, d, e, f, g, h): (T, T, T, T, T, T, T, T, T, T, T, T),
    fill: T
) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial(
    (x, y, z, w, a, b, c, d, e, f, g): (T, T, T, T, T, T, T, T, T, T, T),
    fill: T
) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial(
    (x, y, z, w, a, b, c, d, e, f): (T, T, T, T, T, T, T, T, T, T),
    fill: T
) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial(
    (x, y, z, w, a, b, c, d, e): (T, T, T, T, T, T, T, T, T),
    fill: T
) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial(
    (x, y, z, w, a, b, c, d): (T, T, T, T, T, T, T, T),
    fill: T
) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial(
    (x, y, z, w, a, b, c): (T, T, T, T, T, T, T),
    fill: T
) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T, T)> for Vector<T, N>

pub fn from_partial((x, y, z, w, a, b): (T, T, T, T, T, T), fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T, T)> for Vector<T, N>

pub fn from_partial((x, y, z, w, a): (T, T, T, T, T), fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T, T)> for Vector<T, N>

pub fn from_partial((x, y, z, w): (T, T, T, T), fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T, T)> for Vector<T, N>

pub fn from_partial((x, y, z): (T, T, T), fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T, T)> for Vector<T, N>

pub fn from_partial((x, y): (T, T), fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, (T,)> for Vector<T, N>

pub fn from_partial((x): (T,), fill: T) -> Self

impl<T: Num, const N: usize> FromPartial<T, Vec<T, Global>> for Vector<T, N>

pub fn from_partial(vec: Vec<T>, fill: T) -> Self

impl<T: Hash, const N: usize> Hash for Vector<T, N>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: Num, const N: usize> IntoIterator for Vector<T, N>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T, N>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Num, const N: usize> Mul<&'a T> for Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the * operator.

pub fn mul(self, other: &'a T) -> Self::Output

Performs the * operation.

impl<'a, T: Num, const N: usize, '_> Mul<&'a T> for &'_ Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the * operator.

pub fn mul(self, other: &'a T) -> Self::Output

Performs the * operation.

impl<'a, T: Num, const N: usize> Mul<T> for Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T: Num, const N: usize, '_> Mul<T> for &'_ Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Ord, const N: usize> Ord for Vector<T, N>

pub fn cmp(&self, other: &Vector<T, N>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

pub fn eq(&self, other: &Vector<T, N>) -> bool

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

pub fn ne(&self, other: &Vector<T, N>) -> bool

This method tests for !=.

impl<T: PartialOrd, const N: usize> PartialOrd<Vector<T, N>> for Vector<T, N>

pub fn partial_cmp(&self, other: &Vector<T, N>) -> Option<Ordering>

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

pub fn lt(&self, other: &Vector<T, N>) -> bool

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

pub fn le(&self, other: &Vector<T, N>) -> bool

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

pub fn gt(&self, other: &Vector<T, N>) -> bool

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

pub fn ge(&self, other: &Vector<T, N>) -> bool

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

impl<T, const N: usize> StructuralEq for Vector<T, N>

impl<T, const N: usize> StructuralPartialEq for Vector<T, N>

impl<T: Num, const N: usize, '_> Sub<&'_ Vector<T, N>> for Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the - operator.

pub fn sub(self, other: &Vector<T, N>) -> Self::Output

Performs the - operation.

impl<T: Num, const N: usize, '_, '_> Sub<&'_ Vector<T, N>> for &'_ Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the - operator.

pub fn sub(self, other: &Vector<T, N>) -> Self::Output

Performs the - operation.

impl<T: Num, const N: usize> Sub<Vector<T, N>> for Vector<T, N>

type Output = Vector<T, N>

The resulting type after applying the - operator.

pub fn sub(self, other: Vector<T, N>) -> Self::Output

Performs the - operation.

impl<T: Num, const N: usize, '_> SubAssign<&'_ Vector<T, N>> for Vector<T, N>

pub fn sub_assign(&mut self, other: &Vector<T, N>)

Performs the -= operation.

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

pub fn sub_assign(&mut self, other: Vector<T, N>)

Performs the -= operation.