Struct libmat::mat::Vector

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

Represents a vector.

Implementations

impl<T> Vector<T> where
    T: Clone, 

pub fn new(size: usize, init: T) -> Vector<T>

pub fn to_row_vector(&self) -> Vector<T>

pub fn to_col_vector(&self) -> Vector<T>

pub fn get_size(&self) -> usize

Trait Implementations

impl<T> Add<&'_ Vector<T>> for &Vector<T> where
    T: Add<Output = T> + Clone + Copy, 

Vectors can be added by adding their references.

Example

let vec_a = vector![1, 2, 3];
let vec_b = vector![3, 2, 1];
assert_eq!(&vec_a + &vec_b, Vector::new(3, 4));

type Output = Vector<T>

The resulting type after applying the + operator.

fn add(self, vector: &Vector<T>) -> Self::Output

Performs the + operation.

impl<T> AddAssign<&'_ Vector<T>> for Vector<T> where
    T: Add<Output = T> + Clone + Copy, 

fn add_assign(&mut self, vector: &Vector<T>)

Performs the += operation.

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: Debug> Debug for Vector<T>

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

Formats the value using the given formatter.

impl<T> Div<T> for &Vector<T> where
    T: Div<Output = T> + Mul<Output = T> + Clone + Zero + Copy + One, 

Dividing a vector by a number is the same a multiplying by its inverse.

Example

let vec_a = Vector::new(3, 1_f32);
assert_eq!(&vec_a / 2.0, Vector::new(3, 0.5));

type Output = Vector<T>

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the conversion.

impl<T> From<Vec<T, Global>> for Vector<T> where
    T: Clone, 

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

Performs the conversion.

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

Indexing a vectors returns the corresponding entry.

Example

let vec_a = vector![1, 2, 3];
assert_eq!(vec_a[0], 1);
assert_eq!(vec_a[1], 2);
assert_eq!(vec_a[2], 3);

type Output = T

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

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

Single entries of a vector can be manipulated by mutating an indexed vector.

Example

let mut vec_a = Vector::new(3, 1);
vec_a[1] = 2;
vec_a[2] = 3;
assert_eq!(vec_a[0], 1);
assert_eq!(vec_a[1], 2);
assert_eq!(vec_a[2], 3);
assert_eq!(vec_a, vector![1, 2, 3]);

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

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

impl<T> Into<Matrix<T>> for Vector<T> where
    T: Zero + One + Copy, 

fn into(self) -> Matrix<T>

Performs the conversion.

impl<T> Mul<&'_ Matrix<T>> for &Vector<T> where
    T: One + Zero + Copy + Clone, 

Vectors can also be multiplied with matrices. The result will be a vector.

Example

let mat_a = Matrix::<u32>::one(4);
let mat_b = matrix!{1, 2, 3; 4, 4, 3; 2, 1, 3; 4, 1, 2};
let vec_a = vector![4, 5, 6, 7].to_row_vector();
let vec_b = vector![64, 41, 59].to_row_vector();
assert_eq!(&vec_a * &mat_a, vec_a);
assert_eq!(&vec_a * &mat_b, vec_b);

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, mat: &Matrix<T>) -> Self::Output

Performs the * operation.

impl<T> Mul<&'_ Vector<T>> for &Matrix<T> where
    T: One + Zero + Copy + Clone, 

Matrices can be multiplied with Vectors by multiplying their references. The dimensions of the two objects need to match like with matrix multiplication.

Example

let v_a = vector![1, 2, 3];
let mat_a = matrix!{1, 2, 3; 4, 5, 6; 7, 8, 9};
let v_b = vector![30, 36, 42].to_row_vector();
assert_eq!(&v_a.to_row_vector() * &mat_a, v_b);

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, vec: &Vector<T>) -> Self::Output

Performs the * operation.

impl<T> Mul<&'_ Vector<T>> for &Vector<T> where
    T: Mul<Output = T> + Clone + Copy + Zero, 

Vectors can be multpilied by multiplying their references.

Example

let vec_a = Vector::new(4, 3);
let vec_b = vector![5, 6, 7, 8];
assert_eq!(&vec_a * &vec_b, 78);
assert_eq!(&vec_b * &vec_a, 78);

type Output = T

The resulting type after applying the * operator.

fn mul(self, vec: &Vector<T>) -> Self::Output

Performs the * operation.

impl<T> Mul<T> for &Vector<T> where
    T: Mul<Output = T> + Clone + Zero + Copy, 

Vectors can be scaled by scaling a reference to a vector.

Example

let vec_a = Vector::new(3, 1);
assert_eq!(&vec_a * 2, Vector::new(3, 2));

type Output = Vector<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Neg for &Vector<T> where
    T: Sub<Output = T> + One + Zero + Clone + Copy, 

type Output = Vector<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

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> Sub<&'_ Vector<T>> for &Vector<T> where
    T: Sub<Output = T> + Zero + One + Copy + Clone, 

Vectors can be subtracted by subtracting theri references.

Example

let vec_a = vector![1_i32, 2, 3];
let vec_b = vector![3_i32, 2, 1];
assert_eq!(&vec_a - &vec_b, vector![-2, 0, 2]);

type Output = Vector<T>

The resulting type after applying the - operator.

fn sub(self, vector: &Vector<T>) -> Self::Output

Performs the - operation.

impl<T> SubAssign<&'_ Vector<T>> for Vector<T> where
    T: Sub<Output = T> + Zero + One + Copy + Clone, 

fn sub_assign(&mut self, vector: &Vector<T>)

Performs the -= operation.

impl<T> StructuralPartialEq for Vector<T>