Struct optimath::Vector

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

a const-sized vector of elements, supports all math operations that T does on an element-by-element basis.

can be iterated over using .into_iter() on Vector or &Vector can be constructed from iterators using collect().

is repr(align(16)) for simd

Methods

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

pub fn ascend(self) -> Vector<Self, 1>

impl<'a, 'b, T: 'a + 'b, const M: usize> Vector<T, M> where
    &'a T: Mul<&'b T, Output = T>,
    T: Sum, 

pub default fn dot(&'a self, other: &'b Vector<T, M>) -> T

Trait Implementations

impl<'a, 'b, T, B: 'b, const N: usize> Add<B> for &'a Vector<T, N> where
    &'a T: Add<&'b T, Output = T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

type Output = Vector<T, N>

The resulting type after applying the + operator.

default fn add(self, other: B) -> Vector<T, N>

Performs the + operation.

impl<'a, T, const N: usize> AddAssign<&'a Vector<T, N>> for Vector<T, N> where
    T: AddAssign<&'a T>, 

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

Performs the += operation.

impl<'a, 'b, T, B: 'b, const N: usize> AddAssign<B> for Vector<T, N> where
    T: AddAssign<&'b T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

default fn add_assign(&mut self, other: B)

Performs the += operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn i(self, index: usize) -> &'a T

impl<'a, T, const N: usize> ConstIndex<&'a mut T, N> for &'a mut Vector<T, N>

fn i(self, index: usize) -> &'a mut T

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

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the "default value" for a type.

impl<'de, T, const N: usize> Deserialize<'de> for Vector<T, N> where
    T: Deserialize<'de>, 

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T: Display + Debug, const N: usize> Display for Vector<T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Distribution<Vector<T, N>> for Standard where
    Standard: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Vector<T, N>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl<'a, 'b, T, B: 'b, const N: usize> Div<B> for &'a Vector<T, N> where
    &'a T: Div<&'b T, Output = T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

type Output = Vector<T, N>

The resulting type after applying the / operator.

default fn div(self, other: B) -> Vector<T, N>

Performs the / operation.

impl<'a, T, const N: usize> DivAssign<&'a Vector<T, N>> for Vector<T, N> where
    T: DivAssign<&'a T>, 

fn div_assign(&mut self, other: &'a Vector<T, N>)

Performs the /= operation.

impl<'a, 'b, T, B: 'b, const N: usize> DivAssign<B> for Vector<T, N> where
    T: DivAssign<&'b T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

default fn div_assign(&mut self, other: B)

Performs the /= operation.

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

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

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

Creates a value from an iterator.

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

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.

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

fn index_mut(&mut self, index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T, 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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = ConstIterator<&'a T, &'a Vector<T, N>, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, T, B: 'b, const N: usize> Mul<B> for &'a Vector<T, N> where
    &'a T: Mul<&'b T, Output = T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

type Output = Vector<T, N>

The resulting type after applying the * operator.

default fn mul(self, other: B) -> Vector<T, N>

Performs the * operation.

impl<'a, T, const N: usize> MulAssign<&'a Vector<T, N>> for Vector<T, N> where
    T: MulAssign<&'a T>, 

fn mul_assign(&mut self, other: &'a Vector<T, N>)

Performs the *= operation.

impl<'a, 'b, T, B: 'b, const N: usize> MulAssign<B> for Vector<T, N> where
    T: MulAssign<&'b T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

default fn mul_assign(&mut self, other: B)

Performs the *= operation.

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

fn eq(&self, other: &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, const N: usize> Serialize for Vector<T, N> where
    T: Serialize, 

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

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

fn build_with_fn<F: FnMut(usize) -> T>(f: F) -> Self

impl<'a, 'b, T, B: 'b, const N: usize> Sub<B> for &'a Vector<T, N> where
    &'a T: Sub<&'b T, Output = T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

type Output = Vector<T, N>

The resulting type after applying the - operator.

default fn sub(self, other: B) -> Vector<T, N>

Performs the - operation.

impl<'a, T, const N: usize> SubAssign<&'a Vector<T, N>> for Vector<T, N> where
    T: SubAssign<&'a T>, 

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

Performs the -= operation.

impl<'a, 'b, T, B: 'b, const N: usize> SubAssign<B> for Vector<T, N> where
    T: SubAssign<&'b T>,
    B: ConstIndex<&'b T, N> + Copy + Clone,
    T: 'a + 'b, 

default fn sub_assign(&mut self, other: B)

Performs the -= operation.