Struct DenseMatrix 

pub struct DenseMatrix { /* private fields */ }

Row-major dense matrix stored as a flat Vec<f64>.

Indexing is row * cols + col. All public mutating operations return &mut Self or take &mut self — there are no hidden reallocations after construction.

Examples

use hisab::num::DenseMatrix;

let mut m = DenseMatrix::zeros(2, 3);
m.set(0, 1, 7.0);
assert_eq!(m.get(0, 1), 7.0);

Implementations

impl DenseMatrix

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

Create a zero-filled rows × cols matrix.

pub fn identity(n: usize) -> Self

Create an n × n identity matrix.

pub fn from_rows( rows: usize, cols: usize, data: Vec<f64>, ) -> Result<Self, HisabError>

Construct from a flat row-major Vec<f64>.

Errors

Returns HisabError::InvalidInput if data.len() != rows * cols.

pub fn from_vec_of_vec(v: &[Vec<f64>]) -> Result<Self, HisabError>

Construct from a slice of row vectors.

All rows must have the same length.

Errors

Returns HisabError::InvalidInput if the input is empty or rows have inconsistent lengths.

pub fn to_vec_of_vec(&self) -> Vec<Vec<f64>>

Convert to Vec<Vec<f64>> (row-major).

pub fn rows(&self) -> usize

Number of rows.

pub fn cols(&self) -> usize

Number of columns.

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

Read the element at (row, col).

Panics

Panics in debug builds if row >= self.rows || col >= self.cols.

pub fn get_mut(&mut self, row: usize, col: usize) -> &mut f64

Mutable reference to the element at (row, col).

Panics

Panics in debug builds if row >= self.rows || col >= self.cols.

pub fn row(&self, i: usize) -> &[f64]

Immutable slice of row i.

Panics

Panics in debug builds if i >= self.rows.

pub fn set(&mut self, row: usize, col: usize, val: f64)

Set the element at (row, col) to val.

Panics

Panics in debug builds if row >= self.rows || col >= self.cols.

pub fn mul_vec(&self, x: &[f64]) -> Result<Vec<f64>, HisabError>

Matrix-vector multiply: A · x, returning y = Ax.

Errors

Returns HisabError::InvalidInput if x.len() != self.cols.

pub fn mul_mat(&self, other: &DenseMatrix) -> Result<DenseMatrix, HisabError>

Matrix-matrix multiply: self · other.

Errors

Returns HisabError::InvalidInput if self.cols != other.rows.

pub fn transpose(&self) -> DenseMatrix

Transpose: returns a new cols × rows matrix.

pub fn frobenius_norm(&self) -> f64

Frobenius norm: √(∑ aᵢⱼ²).

Trait Implementations

impl Clone for DenseMatrix

fn clone(&self) -> DenseMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DenseMatrix

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

Formats the value using the given formatter.

impl Index<(usize, usize)> for DenseMatrix

type Output = f64

The returned type after indexing.

fn index(&self, (row, col): (usize, usize)) -> &f64

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for DenseMatrix

fn index_mut(&mut self, (row, col): (usize, usize)) -> &mut f64

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

impl PartialEq for DenseMatrix

fn eq(&self, other: &DenseMatrix) -> 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 StructuralPartialEq for DenseMatrix