Struct Matrix

Source

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

Expand description

§Struct Matrix

A classic implementation of the Matrix data structure

Includes

The possibility to create a Matrix structure starting from various other structures
The possibility to manipulate entire matrices as they were individual items
Operator overloading
Matrix math
Safely reshaping and transposing matrices
Trapping you in a simulation

§A demonstration

use quickbrain::quick_math::matrix::Matrix;
let m : Matrix<f64> = Matrix::from_array([[1., 2., 3.], [4., 5., 6.]]);
// [1, 2, 3]
// [4, 5, 6]
let m2 : Matrix<f64> = Matrix::from_array([[1., 2.], [3., 4.], [5., 6.]]);
// [1, 2]
// [3, 4]
// [5, 6]

// Multiplying matrices by a scalar
// Multiplying matrices by matrices
// Mapping a function to a matrix
let r = m.dot(&(m2 * 2.0).map(|x| x * x));

Implementations§

Source §

impl<T: Copy> Matrix<T>

Source

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

§Get Data

Returns a reference to the plain vector holding the raw data of the matrix Likely not an useful method

Source

pub fn get_data_mut(&mut self) -> &mut Vec<T>

Source

pub fn get_shape(&self) -> Vec<usize>

§Get Shape

Returns a Vec<usize> representing the shape of the Matrix

Source

pub fn get_row_slice(&self, row: usize) -> &[T]

§Get row slice

Returns a row of the matrix as a slice, it’s very fast!

Source

pub fn get_row_slice_mut(&mut self, row: usize) -> &[T]

§Get row slice mut

Returns a mutable reference to a row of the matrix as a slice

Source

pub fn get_row(&self, row: usize) -> impl Iterator<Item = &T>

§Get row

Returns a reference to a given row of the Matrix as an Iterator

Source

pub fn get_row_mut(&mut self, row: usize) -> impl Iterator<Item = &mut T>

§Get row mut

Returns a mutable reference to a given row of the Matrix as an Iterator

Source

pub fn get_col(&self, col: usize) -> impl Iterator<Item = &T>

§Get column

Returns a reference to a given column of the Matrix as an Iterator

Source

pub fn get_col_mut(&mut self, col: usize) -> impl Iterator<Item = &mut T>

§Get column mutable

Returns a mutable reference to a given column of the Matrix as an Iterator

Source

pub fn get_rows(&self) -> usize

§Get rows

A simple getter for the number of rows in the Matrix

Source

pub fn get_cols(&self) -> usize

§Get cols

A simple getter for the number of columns in the Matrix

Source

pub fn map(&self, f: fn(T) -> T) -> Matrix<T>

§Map

Returns a copy of the matrix with a function f applied to it

Source

pub fn apply(&mut self, f: fn(T) -> T)

§Apply

Mutates the matrix by applying a function F to each element

Source

pub fn reshape( &self, new_rows: usize, new_cols: usize, ) -> Result<Matrix<T>, MatrixError>

§Reshape

Returns MatrixError::InvalidReshape if the data doesn’t fit the new size Returns the reshaped matrix otherwise

Source

pub fn repeat_h(&self, times: usize) -> Matrix<T>

Source §

impl Matrix<f64>

Source

pub fn rand(rows: usize, cols: usize) -> Matrix<f64>

§Rand

Creates a matrix filled with random values in the range [0, 1) of a given size

Source

pub fn from_array<const R: usize, const C: usize>( arr: [[f64; C]; R], ) -> Matrix<f64>

§From array

Creates a new Matrix from a 2D array of any shape

§WARNING: Uses static dispatch, this is mostly used for a bunch of constants and for

testing, to not push the limits of it or you will end up with a hige executable

Source

pub fn zero(rows: usize, cols: usize) -> Matrix<f64>

§Zero

Creates a new Matrix of the given shape and fills it with ZEROS

Source

pub fn one(rows: usize, cols: usize) -> Matrix<f64>

§One

Creates a new Matrix of the given shape and fills it with ONES Useful for initializing matrices with dummy values that do not give 0 as a multiplication result

Source