Struct SymbolicMatrix 

pub struct SymbolicMatrix { /* private fields */ }

A symbolic matrix where each element is an Expression.

This is useful for representing parameterized quantum gates, symbolic Hamiltonians, and other matrix expressions.

Implementations

impl SymbolicMatrix

pub fn new(elements: Vec<Vec<Expression>>) -> SymEngineResult<Self>

Create a new symbolic matrix from a 2D array of expressions.

Errors

Returns error if the input is empty

pub fn from_flat( elements: Vec<Expression>, rows: usize, cols: usize, ) -> SymEngineResult<Self>

Create a matrix from a flat vector with specified dimensions.

Errors

Returns error if the dimensions don’t match the vector length

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

Create a zero matrix.

pub fn identity(n: usize) -> Self

Create an identity matrix.

pub fn diagonal(diag: Vec<Expression>) -> Self

Create a diagonal matrix from a vector of diagonal elements.

pub fn from_array(arr: &Array2<f64>) -> Self

Create a matrix from a numeric Array2.

pub fn from_complex_array(arr: &Array2<Complex64>) -> Self

Create a matrix from a complex Array2.

pub const fn nrows(&self) -> usize

Get the number of rows.

pub const fn ncols(&self) -> usize

Get the number of columns.

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

Get the dimensions as (rows, cols).

pub const fn is_square(&self) -> bool

Check if the matrix is square.

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

Get element at (i, j).

Panics

Panics if indices are out of bounds.

pub fn get_mut(&mut self, i: usize, j: usize) -> &mut Expression

Get mutable reference to element at (i, j).

Panics

Panics if indices are out of bounds.

pub fn set(&mut self, i: usize, j: usize, value: Expression)

Set element at (i, j).

Panics

Panics if indices are out of bounds.

pub fn row(&self, i: usize) -> Vec<Expression>

Get a row as a vector of expressions.

pub fn col(&self, j: usize) -> Vec<Expression>

Get a column as a vector of expressions.

pub fn transpose(&self) -> Self

Matrix transpose.

pub fn conjugate(&self) -> Self

Complex conjugate of all elements.

pub fn dagger(&self) -> Self

Hermitian conjugate (conjugate transpose).

pub fn add(&self, other: &Self) -> SymEngineResult<Self>

Matrix addition.

Errors

Returns error if dimensions don’t match.

pub fn sub(&self, other: &Self) -> SymEngineResult<Self>

Matrix subtraction.

Errors

Returns error if dimensions don’t match.

pub fn matmul(&self, other: &Self) -> SymEngineResult<Self>

Matrix multiplication.

Errors

Returns error if inner dimensions don’t match.

pub fn scale(&self, scalar: &Expression) -> Self

Scalar multiplication.

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

Kronecker (tensor) product.

pub fn trace(&self) -> SymEngineResult<Expression>

Matrix trace (sum of diagonal elements).

Errors

Returns error if matrix is not square.

pub fn commutator(&self, other: &Self) -> SymEngineResult<Self>

Commutator [A, B] = AB - BA.

Errors

Returns error if dimensions don’t match or matrices are not square.

pub fn anticommutator(&self, other: &Self) -> SymEngineResult<Self>

Anticommutator {A, B} = AB + BA.

Errors

Returns error if dimensions don’t match.

pub fn simplify(&self) -> Self

Simplify all matrix elements.

pub fn expand(&self) -> Self

Expand all matrix elements.

pub fn eval( &self, values: &HashMap<String, f64>, ) -> SymEngineResult<Array2<f64>>

Evaluate all matrix elements with given variable values.

Errors

Returns error if any element evaluation fails.

pub fn substitute(&self, var: &Expression, value: &Expression) -> Self

Substitute a variable with an expression in all elements.

pub fn diff(&self, var: &Expression) -> Self

Compute the derivative of all elements with respect to a variable.

Trait Implementations

impl Clone for SymbolicMatrix

fn clone(&self) -> SymbolicMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolicMatrix

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

Formats the value using the given formatter.

impl Display for SymbolicMatrix

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

Formats the value using the given formatter.

impl Index<(usize, usize)> for SymbolicMatrix

type Output = Expression

The returned type after indexing.

fn index(&self, index: (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for SymbolicMatrix

fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output

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