Struct matmath::vector::Vector

pub struct Vector<T> { /* fields omitted */ }

A Vector with generic type items. Can be indexed by vector[i]

Methods

impl<T> Vector<T>

pub fn new(coords: Vec<T>) -> Self

Creates a new Vector with the given coordinates

pub fn dim(&self) -> usize

Returns the amount of dimensions the Vector has

pub fn scaled<U, O>(self, scalar: U) -> Vector<O> where
    T: Mul<U, Output = O>,
    U: Clone, 

Multiplies the vector with a scalar

pub fn mag_sqr<O>(self) -> O where
    T: Mul<Output = O> + Clone,
    O: Add<Output = O> + MatrixElement, 

Returns the square of the Magnitude (also called Norm) of the Vector

pub fn mag<O, U: SquareRootable<Output = O>>(self) -> O where
    T: Mul<Output = U> + Clone,
    U: Add<Output = U> + MatrixElement, 

Returns the Magnitude (also called Norm) of the Vector

pub fn dot<U, O: Add<Output = O> + MatrixElement>(
    self,
    rhs: Vector<U>
) -> Result<O, DimensionsDontMatch<usize, usize>> where
    T: Mul<U, Output = O>, 

Returns the Dot Product of the Vector and rhs

pub fn map<F, U>(self, f: F) -> Vector<U> where
    F: Fn(T) -> U, 

Applies a function to every element of the vector

Trait Implementations

impl<T> Into<Vector<T>> for Vector2<T>

fn into(self) -> Vector<T>

Performs the conversion.

impl<T> Into<Vector<T>> for Vector3<T>

fn into(self) -> Vector<T>

Performs the conversion.

impl<T> Into<Vector<T>> for Vector4<T>

fn into(self) -> Vector<T>

Performs the conversion.

impl<T> Into<Matrix<T>> for Vector<T>

A Vector can be cast to a matrix and back

fn into(self) -> Matrix<T>

Performs the conversion.

impl<T: Eq> Eq for Vector<T>

impl<T: PartialEq> PartialEq<Vector<T>> for Vector<T>

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

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

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

This method tests for !=.

impl<T> From<Vector<T>> for Vector2<T>

fn from(vec: Vector<T>) -> Self

Performs the conversion.

impl<T> From<Vector<T>> for Vector3<T>

fn from(vec: Vector<T>) -> Self

Performs the conversion.

impl<T> From<Vector<T>> for Vector4<T>

fn from(vec: Vector<T>) -> Self

Performs the conversion.

impl<T> From<Matrix<T>> for Vector<T>

A Vector can be converted to a matrix and back

fn from(mat: Matrix<T>) -> Self

Performs the conversion.

impl<T: Clone> Clone for Vector<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> IntoIterator for Vector<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Display> Display for Vector<T>

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

Formats the value using the given formatter.

impl<T: Debug> Debug for Vector<T>

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

Formats the value using the given formatter.

impl<T: Add<U, Output = O>, U, O> Add<Vector<U>> for Vector<T>

Adds two vectors element by element

type Output = Vector<O>

The resulting type after applying the + operator.

fn add(self, rhs: Vector<U>) -> Vector<O>

Performs the + operation.

impl<T, U, O> Sub<Vector<U>> for Vector<T> where
    T: Sub<U, Output = O>, 

Subtracts two vectors element by element

type Output = Vector<O>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector<U>) -> Vector<O>

Performs the - operation.

impl<T, U, O> Mul<Vector<U>> for Matrix<T> where
    T: Mul<U, Output = O> + Clone,
    U: Clone,
    O: Add<O, Output = O> + MatrixElement, 

Matrix-Vector Multiplication

type Output = Vector<O>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector<U>) -> Vector<O>

Performs the * operation.

impl<T, O> Neg for Vector<T> where
    T: Neg<Output = O>, 

type Output = Vector<O>

The resulting type after applying the - operator.

fn neg(self) -> Vector<O>

Performs the unary - operation.

impl<T> Index<usize> for Vector<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Vector<T>

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

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

impl<T> FromIterator<T> for Vector<T>

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

Creates a value from an iterator.