Matrix functions and Jordan form
Matrix exponential, logarithm, trigonometric, hyperbolic, and Jordan operations are exact symbolic operations.
exponential#
api::matrix_operations::Matrix method
pub fn exponential(&self) -> Result<Matrix, ApiError>The matrix exponential exp(M), evaluated through the certified Jordan
decomposition. Declines on inputs whose eigenvalues cannot be certified
exactly.
logarithm#
api::matrix_operations::Matrix method
pub fn logarithm(&self) -> Result<Matrix, ApiError>The principal matrix logarithm log(M). Raises on a zero or negative-real
eigenvalue (principal branch cut).
square_root#
api::matrix_operations::Matrix method
pub fn square_root(&self) -> Result<Matrix, ApiError>The principal matrix square root sqrt(M); the result is verified to square
back to M. Raises on a negative-real eigenvalue, or on a nontrivial zero
eigenblock (non-analytic).
sine#
api::matrix_operations::Matrix method
pub fn sine(&self) -> Result<Matrix, ApiError>The primary matrix sine sin(M), evaluated exactly through the certified
Jordan decomposition. The result is certified together with the matrix cosine
by sin(M)^2 + cos(M)^2 = I.
cosine#
api::matrix_operations::Matrix method
pub fn cosine(&self) -> Result<Matrix, ApiError>The primary matrix cosine cos(M), evaluated exactly through the certified
Jordan decomposition and the trigonometric identity certificate.
hyperbolic_sine#
api::matrix_operations::Matrix method
pub fn hyperbolic_sine(&self) -> Result<Matrix, ApiError>The primary hyperbolic matrix sine sinh(M), evaluated exactly through the
certified Jordan decomposition. The result is certified together with the
hyperbolic matrix cosine by cosh(M)^2 - sinh(M)^2 = I.
hyperbolic_cosine#
api::matrix_operations::Matrix method
pub fn hyperbolic_cosine(&self) -> Result<Matrix, ApiError>The primary hyperbolic matrix cosine cosh(M), evaluated exactly through the
certified Jordan decomposition and the hyperbolic identity certificate.
jordan_decomposition#
api::matrix_operations::Matrix method
pub fn jordan_decomposition(
&self,
) -> Result<JordanDecomposition, ApiError>The Jordan decomposition returned as (similarity, jordan_form, blocks) with
, where blocks lists each
Jordan block as an (eigenvalue, size) pair. Every root is certified over an
exact algebraic field. Notes: WASM returns a JordanDecomposition
result class with similarity/jordan_form/blocks getters, each block a
JordanBlock with eigenvalue/size getters.
jordan_decomposition (WASM result class)#
api::matrix_operations::Matrix method
pub fn jordan_decomposition(
&self,
) -> Result<JordanDecomposition, ApiError>similarity#
api::results::JordanDecomposition method
pub fn similarity(&self) -> Matrixjordan_form#
api::results::JordanDecomposition method
pub fn jordan_form(&self) -> MatrixThe Jordan form itself.
blocks#
api::results::JordanDecomposition method
pub fn blocks(&self) -> Vec<JordanBlock>The Jordan blocks, in the order they appear on the diagonal.
jordan_block (WASM result class)#
size#
The jordan_block.eigenvalue -> Expression getter reuses the shared
eigenvalue heading documented above.
api::results::JordanBlock method
pub fn size(&self) -> usizeThe block's side length.
Example#
This family is not part of the recommended symi::api facade in this release. Call it through the native modules in the native Rust API reference.
Additional API#
api::matrix_operations#
api module
pub mod matrix_operations;Matrix function and decomposition operations of the native API.
JordanBlock#
api re_export
pub use results::JordanBlock;One Jordan block of a Jordan decomposition.
JordanBlock.eigenvalue#
api::results::JordanBlock method
pub fn eigenvalue(&self) -> ExpressionThe eigenvalue on the block's diagonal.
JordanDecomposition#
api re_export
pub use results::JordanDecomposition;A Jordan decomposition similarity * jordan_form * similarity^-1.