Struct Matrix

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

A column‑major 2D matrix of T. Index as Array(row, column).

Implementations

impl<T: Clone> Matrix<T>

pub fn from_cols(cols_data: Vec<Vec<T>>) -> Self

Build from columns (each inner Vec is one column)

pub fn from_vec(data: Vec<T>, rows: usize, cols: usize) -> Self

Build from a flat Vec, assuming column-major order.

pub fn from_rows_vec(data: Vec<T>, rows: usize, cols: usize) -> Self

Build from a flat Vec, assuming row-major order.

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

pub fn data_mut(&mut self) -> &mut [T]

pub fn into_vec(self) -> Vec<T>

Consumes the Matrix and returns its underlying data Vec.

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

Creates a new Vec<T> containing the matrix data (cloned).

pub fn rows(&self) -> usize

pub fn cols(&self) -> usize

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

pub fn get(&self, r: usize, c: usize) -> &T

Get element reference (immutable). Panics on out-of-bounds.

pub fn get_mut(&mut self, r: usize, c: usize) -> &mut T

Get element reference (mutable). Panics on out-of-bounds.

pub fn column(&self, c: usize) -> &[T]

pub fn column_mut(&mut self, c: usize) -> &mut [T]

pub fn iter_columns(&self) -> impl Iterator<Item = &[T]>

pub fn iter_rows(&self) -> impl Iterator<Item = MatrixRow<'_, T>>

pub fn swap_columns(&mut self, c1: usize, c2: usize)

Swaps two columns in the matrix. Panics on out-of-bounds.

pub fn delete_column(&mut self, col: usize)

Deletes a column from the matrix. Panics on out-of-bounds. This is O(N) where N is the number of elements.

pub fn row(&self, r: usize) -> Vec<T>

pub fn row_copy_from_slice(&mut self, r: usize, values: &[T])

pub fn delete_row(&mut self, row: usize)

Deletes a row from the matrix. Panics on out-of-bounds. This is O(N) where N is the number of elements, as it rebuilds the data vec.

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

impl<T: Clone> Matrix<T>

pub fn add_column(&mut self, index: usize, column: Vec<T>)

Adds a column to the matrix at the specified index. Panics if index > cols or length mismatch. This is O(N) where N is the number of elements.

pub fn add_row(&mut self, index: usize, row: Vec<T>)

Adds a row to the matrix at the specified index. Panics if index > rows or length mismatch. This is O(N) where N is the number of elements, as it rebuilds the data vec.

pub fn repeat_rows(&self, n: usize) -> Matrix<T>

where T: Clone,

Return a new matrix where row 0 of self is repeated n times.

pub fn filled(rows: usize, cols: usize, value: T) -> Self

Creates a new matrix filled with a specific value of the specified size.

pub fn broadcast_row_to_target_shape( &self, target_rows: usize, target_cols: usize, ) -> Matrix<T>

Creates a new matrix by broadcasting a 1-row matrix to a target shape. Panics if self is not a 1-row matrix or if self.cols() does not match target_cols.

impl Matrix<f64>

pub fn zeros(rows: usize, cols: usize) -> Self

Creates a new matrix filled with zeros of the specified size.

pub fn ones(rows: usize, cols: usize) -> Self

Creates a new matrix filled with ones of the specified size.

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

Creates a new matrix filled with NaN values of the specified size.

impl<T: PartialOrd + Clone> Matrix<T>

pub fn eq_elem<Rhs>(&self, rhs: Rhs) -> BoolMatrix

where Rhs: Broadcastable<T>,

Element-wise comparison self == rhs, where rhs may be a Matrix<T> or a scalar T. Returns a BoolMatrix.

pub fn ne_elem<Rhs>(&self, rhs: Rhs) -> BoolMatrix

where Rhs: Broadcastable<T>,

Element-wise comparison self != rhs, where rhs may be a Matrix<T> or a scalar T. Returns a BoolMatrix.

pub fn lt_elem<Rhs>(&self, rhs: Rhs) -> BoolMatrix

where Rhs: Broadcastable<T>,

Element-wise comparison self < rhs, where rhs may be a Matrix<T> or a scalar T. Returns a BoolMatrix.

pub fn le_elem<Rhs>(&self, rhs: Rhs) -> BoolMatrix

where Rhs: Broadcastable<T>,

Element-wise comparison self <= rhs, where rhs may be a Matrix<T> or a scalar T. Returns a BoolMatrix.

pub fn gt_elem<Rhs>(&self, rhs: Rhs) -> BoolMatrix

where Rhs: Broadcastable<T>,

Element-wise comparison self > rhs, where rhs may be a Matrix<T> or a scalar T. Returns a BoolMatrix.

pub fn ge_elem<Rhs>(&self, rhs: Rhs) -> BoolMatrix

where Rhs: Broadcastable<T>,

Element-wise comparison self >= rhs, where rhs may be a Matrix<T> or a scalar T. Returns a BoolMatrix.

Trait Implementations

impl<'a, 'b, T> Add<&'b Matrix<T>> for &'a Matrix<T>

where T: Clone + Add<Output = T>,

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'b, T> Add<&'b Matrix<T>> for Matrix<T>

where T: Clone + Add<Output = T>,

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<Matrix<T>> for &'a Matrix<T>

where T: Clone + Add<Output = T>,

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, rhs: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<T> for &'a Matrix<T>

where T: Clone + Add<Output = T>,

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Matrix<T>

Performs the + operation.

impl<T> Add<T> for Matrix<T>

where T: Clone + Add<Output = T>,

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Matrix<T>

Performs the + operation.

impl<T> Add for Matrix<T>

where T: Clone + Add<Output = T>,

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, rhs: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b> BitAnd<&'b Matrix<bool>> for &'a Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'b Matrix<bool>) -> Matrix<bool>

Performs the & operation.

impl<'b> BitAnd<&'b Matrix<bool>> for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'b Matrix<bool>) -> Matrix<bool>

Performs the & operation.

impl<'a> BitAnd<Matrix<bool>> for &'a Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the & operator.

fn bitand(self, rhs: Matrix<bool>) -> Matrix<bool>

Performs the & operation.

impl BitAnd for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the & operator.

fn bitand(self, rhs: Matrix<bool>) -> Matrix<bool>

Performs the & operation.

impl<'a, 'b> BitOr<&'b Matrix<bool>> for &'a Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'b Matrix<bool>) -> Matrix<bool>

Performs the | operation.

impl<'b> BitOr<&'b Matrix<bool>> for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'b Matrix<bool>) -> Matrix<bool>

Performs the | operation.

impl<'a> BitOr<Matrix<bool>> for &'a Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the | operator.

fn bitor(self, rhs: Matrix<bool>) -> Matrix<bool>

Performs the | operation.

impl BitOr for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the | operator.

fn bitor(self, rhs: Matrix<bool>) -> Matrix<bool>

Performs the | operation.

impl<'a, 'b> BitXor<&'b Matrix<bool>> for &'a Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'b Matrix<bool>) -> Matrix<bool>

Performs the ^ operation.

impl<'b> BitXor<&'b Matrix<bool>> for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'b Matrix<bool>) -> Matrix<bool>

Performs the ^ operation.

impl<'a> BitXor<Matrix<bool>> for &'a Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Matrix<bool>) -> Matrix<bool>

Performs the ^ operation.

impl BitXor for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Matrix<bool>) -> Matrix<bool>

Performs the ^ operation.

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

fn to_vec(&self, rows: usize, cols: usize) -> Vec<T>

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<'a, 'b, T> Div<&'b Matrix<T>> for &'a Matrix<T>

where T: Clone + Div<Output = T>,

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the / operation.

impl<'b, T> Div<&'b Matrix<T>> for Matrix<T>

where T: Clone + Div<Output = T>,

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the / operation.

impl<'a, T> Div<Matrix<T>> for &'a Matrix<T>

where T: Clone + Div<Output = T>,

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, rhs: Matrix<T>) -> Matrix<T>

Performs the / operation.

impl<'a, T> Div<T> for &'a Matrix<T>

where T: Clone + Div<Output = T>,

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Matrix<T>

Performs the / operation.

impl<T> Div<T> for Matrix<T>

where T: Clone + Div<Output = T>,

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Matrix<T>

Performs the / operation.

impl<T> Div for Matrix<T>

where T: Clone + Div<Output = T>,

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, rhs: Matrix<T>) -> Matrix<T>

Performs the / operation.

impl<T> Index<(usize, usize)> for Matrix<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for Matrix<T>

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

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

impl<'a, 'b, T> Mul<&'b Matrix<T>> for &'a Matrix<T>

where T: Clone + Mul<Output = T>,

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'b, T> Mul<&'b Matrix<T>> for Matrix<T>

where T: Clone + Mul<Output = T>,

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<Matrix<T>> for &'a Matrix<T>

where T: Clone + Mul<Output = T>,

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<T> for &'a Matrix<T>

where T: Clone + Mul<Output = T>,

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Matrix<T>

Performs the * operation.

impl<T> Mul<T> for Matrix<T>

where T: Clone + Mul<Output = T>,

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Matrix<T>

Performs the * operation.

impl<T> Mul for Matrix<T>

where T: Clone + Mul<Output = T>,

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl Not for &Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the ! operator.

fn not(self) -> Matrix<bool>

Performs the unary ! operation.

impl Not for Matrix<bool>

type Output = Matrix<bool>

The resulting type after applying the ! operator.

fn not(self) -> Matrix<bool>

Performs the unary ! operation.

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

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<'a, 'b, T> Sub<&'b Matrix<T>> for &'a Matrix<T>

where T: Clone + Sub<Output = T>,

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'b, T> Sub<&'b Matrix<T>> for Matrix<T>

where T: Clone + Sub<Output = T>,

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<Matrix<T>> for &'a Matrix<T>

where T: Clone + Sub<Output = T>,

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<T> for &'a Matrix<T>

where T: Clone + Sub<Output = T>,

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Matrix<T>

Performs the - operation.

impl<T> Sub<T> for Matrix<T>

where T: Clone + Sub<Output = T>,

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Matrix<T>

Performs the - operation.

impl<T> Sub for Matrix<T>

where T: Clone + Sub<Output = T>,

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Matrix<T>) -> Matrix<T>

Performs the - operation.

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

impl<T> StructuralPartialEq for Matrix<T>