Struct Matrix 

pub struct Matrix<const R: usize, const C: usize> { /* private fields */ }

Dense R × C f64 matrix.

Implementations

impl<const R: usize, const C: usize> Matrix<R, C>

pub const ZERO: Self

Zero matrix.

pub const fn from_rows(rows: [[f64; C]; R]) -> Self

From rows.

pub fn from_fn(element: impl FnMut(usize, usize) -> f64) -> Self

Element (row, column) from a closure.

pub const fn rows(&self) -> &[[f64; C]; R]

Rows.

pub fn get(&self, row: usize, column: usize) -> Option<f64>

Element at (row, column); None outside.

pub fn set(&mut self, row: usize, column: usize, value: f64) -> bool

Sets element (row, column); returns false and does nothing outside the matrix.

pub fn transpose(&self) -> Matrix<C, R>

Transpose.

pub fn scaled(&self, factor: f64) -> Self

Scalar multiple.

pub fn is_finite(&self) -> bool

Whether all elements are finite.

pub fn max_abs(&self) -> f64

Maximum absolute element.

impl<const N: usize> Matrix<N, N>

pub fn identity() -> Self

Identity.

pub fn diagonal(values: [f64; N]) -> Self

Diagonal matrix.

pub fn trace(&self) -> f64

Trace.

pub fn symmetrised(&self) -> Self

(A + Aᵀ) / 2: exactly symmetric; unchanged for a symmetric input.

Removes the last-place asymmetries a covariance accumulates through products.

pub fn cholesky(&self) -> Option<Cholesky<N>>

Cholesky factor L with self = L Lᵀ; None unless symmetric positive definite.

A pivot ≤ 0 within a matrix-scaled tolerance (an unobserved state can have exactly zero variance) means not positive definite; the result is None, not a factor of NaNs. Non-iterative: N³/6 operations.

pub fn is_covariance(&self) -> bool

Whether symmetric (relative tolerance) and positive semi-definite, as judged by Matrix::cholesky.

impl<const N: usize> Matrix<N, 1>

pub fn from_column(values: [f64; N]) -> Self

From elements.

pub fn to_column(&self) -> [f64; N]

Elements.

pub fn element(&self, row: usize) -> Option<f64>

Element at row; None outside.

pub fn dot(&self, other: &Self) -> f64

Dot product.

pub fn norm(&self) -> f64

Euclidean norm.

Trait Implementations

impl<const R: usize, const C: usize> Add for Matrix<R, C>

type Output = Matrix<R, C>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<const R: usize, const C: usize> Clone for Matrix<R, C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const R: usize, const C: usize> Copy for Matrix<R, C>

impl<const R: usize, const C: usize> Debug for Matrix<R, C>

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

Formats the value using the given formatter.

impl<const R: usize, const K: usize, const C: usize> Mul<Matrix<K, C>> for Matrix<R, K>

type Output = Matrix<R, C>

The resulting type after applying the * operator.

fn mul(self, other: Matrix<K, C>) -> Matrix<R, C>

Performs the * operation.

impl<const R: usize, const C: usize> PartialEq for Matrix<R, C>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const R: usize, const C: usize> StructuralPartialEq for Matrix<R, C>

impl<const R: usize, const C: usize> Sub for Matrix<R, C>

type Output = Matrix<R, C>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.