Struct matrix_lib::Matrix

pub struct Matrix<T> { /* private fields */ }

Implementations

impl<T> Matrix<T>where T: Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Neg<Output = T> + AddAssign + SubAssign + MulAssign + DivAssign + Clone + One + Zero + PartialEq + Copy + ToPrimitive + Send + 'static,

pub async fn par_scalar_mul(self, scalar: T) -> Matrix<T>

pub async fn par_mul(self, other: Matrix<T>) -> Result<Matrix<T>, String>

pub async fn par_sum(self, other: Matrix<T>) -> Result<Matrix<T>, String>

impl<T> Matrix<T>where T: Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + Neg<Output = T> + AddAssign + SubAssign + MulAssign + DivAssign + Clone + One + Zero + PartialEq + Copy + ToPrimitive,

pub fn new(matrix: Vec<Vec<T>>) -> Matrix<T>

Creates a new Matrix<T>.

Panics

Panics if rows of matrix are different size. example: matrix![[1, 2, 3], [4,5]]

pub fn sum(&self, other: Matrix<T>) -> Result<Self, String>

Sums two matrices of same size.

Errors

This function will return an error if matrices are different sizes.

examples:

use matrix_lib::*;
let m1 = matrix![[1,2,3], [4,5,6]];
let m2 = matrix![[1,2], [3,4], [5,6]];
assert!(matches!(m1.sum(m2), Err(String)));

will not sum successfully

Examples of correct usage

use matrix_lib::*;
let m1 = matrix![[1,2,3], [4,5,6]];
let m2 = matrix![[1,2,3], [4,5,6]];
assert_eq!(matrix![[2,4,6], [8,10,12]], m1.sum(m2).unwrap());

pub fn mul(&self, other: Matrix<T>) -> Result<Self, String>

Multiplies two matrices.

Errors

ERRORS WIP IN THIS FUNCTION This function will return an error if …

pub fn scalar_mul(&self, scalar: T) -> Self

Multiplies two matrices.

pub fn transpose(&self) -> Matrix<T>

Returns the transpose of this Matrix<T>.

pub fn gaussian_elimination(&self) -> Matrix<f64>

Returns the gaussian elimination of this Matrix<T>.

Panics

Panics if type T is not convertable to f64 as f64 is needed to calculate this correctly.

pub fn determinant(&self) -> Result<f64, String>

Returns the determinant of this Matrix<T>.

Errors

This function will return an error if matrix is not square.

pub fn vectorize(&self) -> Vec<T>

Returns the vectorize of this Matrix<T>.

pub fn from_vectorized(v: Vec<T>, columns: usize) -> Matrix<T>

Generates Matrix<T> from provided vector.

Example

use matrix_lib::*;
let v = vec![1, 2, 3, 4, 5, 6, 7, 8, 9];
assert_eq!(matrix![1,4,7;2,5,8;3,6,9], Matrix::from_vectorized(v, 3));

pub fn inverse(&self) -> Result<Matrix<f64>, String>

Returns the inverse of this Matrix<T>.

Panics

Panics if type T is not convertable to f64 as f64 is needed to calculate this correctly.

Errors

This function will return an error if matrix is not suqare or determinant from given matrix is equal to 0.

pub fn get_size(&self) -> Size

Returns the get size of this Matrix<T>.

Example

use matrix_lib::*;
use matrix_lib::functions::Size;
let m = matrix![1,2,3;4,5,6;7,8,9;10,11,12];
assert_eq!(m.get_size(), Size{x: 3, y: 4});

Trait Implementations

impl<T: Clone> Clone for Matrix<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Matrix<T>

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

Formats the value using the given formatter.

impl<T> Display for Matrix<T>where T: Display,

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<Matrix<T>> for Matrix<T>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for Matrix<T>

impl<T> StructuralEq for Matrix<T>

impl<T> StructuralPartialEq for Matrix<T>