Struct Matrix 

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

A 2D matrix of floating-point values (row-major storage).

Examples

use aprender::primitives::Matrix;

let m = Matrix::from_vec(2, 3, vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]).expect("data length matches rows * cols");
assert_eq!(m.shape(), (2, 3));

Implementations

impl<T> Matrix<T>

where T: Copy,

pub fn from_vec( rows: usize, cols: usize, data: Vec<T>, ) -> Result<Matrix<T>, &'static str>

Creates a new matrix from a vector of data.

Errors

Returns an error if data length doesn’t match rows * cols.

pub fn shape(&self) -> (usize, usize)

Returns the shape as (rows, cols).

pub fn n_rows(&self) -> usize

Returns the number of rows.

pub fn n_cols(&self) -> usize

Returns the number of columns.

pub fn get(&self, row: usize, col: usize) -> T

Gets element at (row, col).

Panics

Panics if indices are out of bounds.

pub fn set(&mut self, row: usize, col: usize, value: T)

Sets element at (row, col).

Panics

Panics if indices are out of bounds.

pub fn row(&self, row_idx: usize) -> Vector<T>

Returns a row as a Vector.

pub fn column(&self, col_idx: usize) -> Vector<T>

Returns a column as a Vector.

pub fn as_slice(&self) -> &[T]

Returns the underlying data as a slice.

impl Matrix<f32>

pub fn zeros(rows: usize, cols: usize) -> Matrix<f32>

Creates a matrix of zeros.

pub fn ones(rows: usize, cols: usize) -> Matrix<f32>

Creates a matrix of ones.

pub fn eye(n: usize) -> Matrix<f32>

Creates an identity matrix.

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

Transposes the matrix.

pub fn matmul(&self, other: &Matrix<f32>) -> Result<Matrix<f32>, &'static str>

Matrix-matrix multiplication.

Errors

Returns an error if dimensions don’t match.

pub fn matvec(&self, vec: &Vector<f32>) -> Result<Vector<f32>, &'static str>

Matrix-vector multiplication.

Errors

Returns an error if dimensions don’t match.

pub fn add(&self, other: &Matrix<f32>) -> Result<Matrix<f32>, &'static str>

Adds another matrix element-wise.

Errors

Returns an error if dimensions don’t match.

pub fn sub(&self, other: &Matrix<f32>) -> Result<Matrix<f32>, &'static str>

Subtracts another matrix element-wise.

Errors

Returns an error if dimensions don’t match.

pub fn mul_scalar(&self, scalar: f32) -> Matrix<f32>

Multiplies each element by a scalar.

pub fn cholesky_solve( &self, b: &Vector<f32>, ) -> Result<Vector<f32>, &'static str>

Solves the linear system Ax = b using Cholesky decomposition.

The matrix must be symmetric positive definite.

Errors

Returns an error if the matrix is not square or not positive definite.

Trait Implementations

impl<T> Clone for Matrix<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Matrix<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Matrix<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Matrix<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> PartialEq for Matrix<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for Matrix<T>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for Matrix<T>