Struct Vector

pub struct Vector<E, const LEN: usize>(pub [E; LEN])
where
    E: MatEl;

A vector structure.

Tuple Fields

0: [E; LEN]

Implementations

impl<E: MatEl + NdFloat, const LEN: usize> Vector<E, LEN>

pub fn normalize(self) -> Self

Normalizes the vector

pub fn mag(&self) -> E

Compute the length of the vector

pub fn mag2(&self) -> E

Computer the squared length of the vector

pub fn min(self, rhs: Self) -> Self

Compute a vector, whose elements are minimum of both vectors: r[ i ] = a[ i ].min( b [ i ] )

pub fn max(self, rhs: Self) -> Self

Compute a vector, whose elements are maximum of both vectors: r[ i ] = a[ i ].max( b [ i ] )

pub fn distance(&self, rhs: &Self) -> E

Computes length of the vector between two points in space

pub fn distance_squared(&self, rhs: &Self) -> E

Computes squared length of the vector between two points in space

impl<E, const LEN: usize> Vector<E, LEN>

where E: MatEl,

pub fn to_array(&self) -> [E; LEN]

impl<E: MatEl + NdFloat> Vector<E, 2>

pub fn x(&self) -> E

pub fn y(&self) -> E

impl Vector<f32, 2>

pub const X: Self

Unit x vector

pub const Y: Self

Unit y vector

pub const MIN: Self

All elements are f32::MIN

pub const MAX: Self

All elements are f32::MAX

pub const ZERO: Self

All elemets are ZERO

pub const fn new(x: f32, y: f32) -> Self

Create a new vector

pub const fn splat(v: f32) -> Self

Creates a vector from a single value : [ v ; N ]

impl<E: MatEl + NdFloat> Vector<E, 3>

pub fn x(&self) -> E

pub fn y(&self) -> E

pub fn z(&self) -> E

pub fn cross(self, rhs: Self) -> Self

impl Vector<f32, 3>

pub const X: Self

Unit x vector

pub const Y: Self

Unit y vector

pub const Z: Self

Unit z vector

pub const MIN: Self

All elements are f32::MIN

pub const MAX: Self

All elements are f32::MAX

pub const ZERO: Self

All elemets are ZERO

pub const fn new(x: f32, y: f32, z: f32) -> Self

Creates a new vector

pub const fn splat(v: f32) -> Self

Creates a vector from a single value : [ v ; N ]

impl<E: MatEl + NdFloat> Vector<E, 4>

pub fn x(&self) -> E

pub fn y(&self) -> E

pub fn z(&self) -> E

pub fn w(&self) -> E

impl Vector<f32, 4>

pub const X: Self

Unit x vector

pub const Y: Self

Unit y vector

pub const Z: Self

Unit z vector

pub const W: Self

Unit w vector

pub const MIN: Self

All elements are f32::MIN

pub const MAX: Self

All elements are f32::MAX

pub const ZERO: Self

All elemets are ZERO

pub const fn new(x: f32, y: f32, z: f32, w: f32) -> Self

Creates a new vector

pub const fn splat(v: f32) -> Self

Creates a vector from a single value : [ v ; N ]

Trait Implementations

impl<E, const LEN: usize> Add for &Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E, const LEN: usize> Add for Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<E, const LEN: usize> AddAssign for Vector<E, LEN>

where E: MatEl + NdFloat,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<E, const LEN: usize> Clone for Vector<E, LEN>

where E: MatEl + Clone,

fn clone(&self) -> Vector<E, LEN>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E, const N: usize> Collection for Vector<E, N>

where E: MatEl,

type Scalar = E

The scalar type contained in the collection.

impl<E, const N: usize> ConstLength for Vector<E, N>

where E: MatEl,

const LEN: usize = N

The length of the entity.

impl<E, const LEN: usize> Debug for Vector<E, LEN>

where E: MatEl + Debug,

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

Formats the value using the given formatter.

impl<E: MatEl, const LEN: usize> Default for Vector<E, LEN>

fn default() -> Self

Returns the “default value” for a type.

impl<E, const LEN: usize> Div<E> for Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<E, const LEN: usize> DivAssign<E> for Vector<E, LEN>

where E: MatEl + NdFloat,

fn div_assign(&mut self, rhs: E)

Performs the /= operation.

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

fn from(value: [E; N]) -> Self

Converts to this type from the input type.

impl<E, const N: usize> From<E> for Vector<E, N>

where E: MatEl,

fn from(value: E) -> Self

Converts to this type from the input type.

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

fn from(value: Vector<E, N>) -> Self

Converts to this type from the input type.

impl<E, const LEN: usize> Hash for Vector<E, LEN>

where E: MatEl + Hash,

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<E, const ROWS: usize, const COLS: usize, Descriptor> Mul<&Vector<E, COLS>> for &Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>,

type Output = Vector<E, COLS>

The resulting type after applying the * operator.

fn mul(self, rhs: &Vector<E, COLS>) -> Self::Output

Performs the * operation.

impl<E, const LEN: usize> Mul<E> for Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> Mul<Vector<E, COLS>> for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>,

type Output = Vector<E, COLS>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector<E, COLS>) -> Self::Output

Performs the * operation.

impl<const LEN: usize> Mul<Vector<f32, LEN>> for f32

type Output = Vector<f32, LEN>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const LEN: usize> Mul<Vector<f64, LEN>> for f64

type Output = Vector<f64, LEN>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<E, const LEN: usize> Mul for Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<E, const LEN: usize> MulAssign<E> for Vector<E, LEN>

where E: MatEl + NdFloat,

fn mul_assign(&mut self, rhs: E)

Performs the *= operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> MulAssign<Mat<ROWS, COLS, E, Descriptor>> for Vector<E, COLS>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>,

fn mul_assign(&mut self, rhs: Mat<ROWS, COLS, E, Descriptor>)

Performs the *= operation.

impl<E, const LEN: usize> PartialEq for Vector<E, LEN>

where E: MatEl + PartialEq,

fn eq(&self, other: &Vector<E, LEN>) -> 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<E, const LEN: usize> PartialOrd for Vector<E, LEN>

where E: MatEl + PartialOrd,

fn partial_cmp(&self, other: &Vector<E, LEN>) -> 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<E, const LEN: usize> Sub<E> for Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<E, const LEN: usize> Sub for &Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<E, const LEN: usize> Sub for Vector<E, LEN>

where E: MatEl + NdFloat,

type Output = Vector<E, LEN>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<E, const LEN: usize> SubAssign for Vector<E, LEN>

where E: MatEl + NdFloat,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<E, const N: usize> TryFrom<&[E]> for Vector<E, N>

where E: MatEl,

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &[E]) -> Result<Self, Self::Error>

Performs the conversion.

impl<E, const N: usize> VectorIter<E, N> for Vector<E, N>

where E: MatEl,

fn vector_iter<'a>(&'a self) -> impl VectorIteratorRef<'a, &'a E>

where E: 'a,

impl<E, const N: usize> VectorIterMut<E, N> for Vector<E, N>

where E: MatEl,

fn vector_iter_mut<'a>(&'a mut self) -> impl VectorIterator<'a, &'a mut E>

where E: 'a,

impl<E, const N: usize> VectorMut<E, N> for Vector<E, N>

where E: MatEl,

fn vector_mut(&mut self) -> &mut [E; N]

Returns a mutable reference to a fixed-size array from the collection.

impl<E, const N: usize> VectorRef<E, N> for Vector<E, N>

where E: MatEl,

fn vector_ref(&self) -> &[E; N]

Returns a reference to a fixed-size array from the collection.

impl<E, const LEN: usize> Copy for Vector<E, LEN>

where E: MatEl + Copy,

impl<E, const LEN: usize> StructuralPartialEq for Vector<E, LEN>

where E: MatEl,