Struct SymMat 

pub struct SymMat {
    pub rows: usize,
    pub cols: usize,
    pub data: Vec<E>,
}

Symbolic matrix of expressions.

Stored in row-major order. Supports transpose, matrix multiplication, matrix-vector product, element-wise differentiation, and code generation.

Fields

rows: usize

Number of rows.

cols: usize

Number of columns.

data: Vec<E>

Row-major element data.

Implementations

impl SymMat

pub fn new<I>(rows: usize, cols: usize, data: I) -> Self

where I: IntoIterator, I::Item: Into<E>,

Create a matrix from dimensions and row-major data. Accepts any iterable of Into<E> so you can pass bare numeric literals: SymMat::new(2, 2, [1.0, 2.0, 3.0, 4.0]).

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

Create a zero matrix of the given dimensions.

pub fn identity(n: usize) -> Self

Create an n-by-n identity matrix.

pub fn get(&self, i: usize, j: usize) -> &E

Get a reference to the element at row i, column j.

pub fn set(&mut self, i: usize, j: usize, val: E)

Set the element at row i, column j.

pub fn transpose(&self) -> SymMat

Return the transpose of this matrix.

pub fn diff(&self, var: impl AsVarName) -> SymMat

Differentiate every element with respect to a variable.

pub fn eval(&self, vars: &HashMap<&str, f64>) -> Result<Vec<Vec<f64>>, String>

Evaluate every element numerically, returning a nested Vec<Vec<f64>>.

pub fn simplify(&self) -> SymMat

Simplify every element.

pub fn expand(&self) -> SymMat

Expand every element (distribute products over sums).

pub fn subs(&self, var: impl AsVarName, replacement: &E) -> SymMat

Substitute a variable in every element.

pub fn to_latex(&self) -> String

Format the matrix as a LaTeX pmatrix.

pub fn to_rust(&self, ft: &str) -> String

Generate Rust source code for the matrix as a nested array literal.

Trait Implementations

impl Add for SymMat

type Output = SymMat

The resulting type after applying the + operator.

fn add(self, rhs: SymMat) -> SymMat

Performs the + operation.

impl Clone for SymMat

fn clone(&self) -> SymMat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymMat

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

Formats the value using the given formatter.

impl Display for SymMat

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

Formats the value using the given formatter.

impl Mul<E> for SymMat

type Output = SymMat

The resulting type after applying the * operator.

fn mul(self, rhs: E) -> SymMat

Performs the * operation.

impl Mul<SymMat> for E

type Output = SymMat

The resulting type after applying the * operator.

fn mul(self, rhs: SymMat) -> SymMat

Performs the * operation.

impl Mul<SymVec> for SymMat

type Output = SymVec

The resulting type after applying the * operator.

fn mul(self, rhs: SymVec) -> SymVec

Performs the * operation.

impl Mul for SymMat

type Output = SymMat

The resulting type after applying the * operator.

fn mul(self, rhs: SymMat) -> SymMat

Performs the * operation.

impl PartialEq for SymMat

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