Skip to content
Symi Docs
WASM / JavaScript

Signatures in the WASM / JavaScript view are TypeScript. Where the JavaScript facade wraps an operation its form is listed first; the other calling forms are the raw wasm-bindgen exports.

On this page

Matrix functions and Jordan form

Matrix exponential, logarithm, trigonometric, hyperbolic, and Jordan operations are exact symbolic operations.

exponential#

Raw WebAssembly: Matrix method

exponential(): Matrix

The matrix exponential exp(M), evaluated through the certified Jordan decomposition. Declines on inputs whose eigenvalues cannot be certified exactly.

logarithm#

Raw WebAssembly: Matrix method

logarithm(): Matrix

The principal matrix logarithm log(M). Raises on a zero or negative-real eigenvalue (principal branch cut).

square_root#

Raw WebAssembly: Matrix method

squareRoot(): Matrix

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#

Raw WebAssembly: Matrix method

sine(): Matrix

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#

Raw WebAssembly: Matrix method

cosine(): Matrix

The primary matrix cosine cos(M), evaluated exactly through the certified Jordan decomposition and the trigonometric identity certificate.

hyperbolic_sine#

Raw WebAssembly: Matrix method

hyperbolicSine(): Matrix

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#

Raw WebAssembly: Matrix method

hyperbolicCosine(): Matrix

The primary hyperbolic matrix cosine cosh(M), evaluated exactly through the certified Jordan decomposition and the hyperbolic identity certificate.

jordan_decomposition#

Raw WebAssembly: Matrix method

jordanDecomposition(): JordanDecomposition

The Jordan decomposition returned as (similarity, jordan_form, blocks) with similarity⁡jordan_form⁡similarity⁡−1=M\operatorname{similarity} \operatorname{jordan\_form} \operatorname{similarity}^{-1} = M, 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)#

Not exposed by the WASM / JavaScript bindings. Available as Matrix.jordan_decomposition in Python, UniffiMatrix.jordanDecomposition in Kotlin, UniffiMatrix.jordanDecomposition in Swift, api::matrix_operations::Matrix::jordan_decomposition in Rust.

similarity#

Raw WebAssembly: JordanDecomposition property

readonly similarity: Matrix

jordan_form#

Not exposed by the WASM / JavaScript bindings. Available as UniffiJordanDecomposition.jordanForm in Kotlin, UniffiJordanDecomposition.jordanForm in Swift, api::results::JordanDecomposition::jordan_form in Rust.

blocks#

Raw WebAssembly: JordanDecomposition property

readonly blocks: 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.

Raw WebAssembly: JordanBlock property

readonly size: number

The size of this Jordan block.

Example#

This family is not part of the recommended JavaScript facade in this release. Call it through the generated symi.raw layer, whose entries are listed with their wasm-bindgen signatures above, and read Migration for the ownership rules that apply there.

Additional API#

JordanBlock#

JordanBlock.eigenvalue#

Raw WebAssembly: JordanBlock property

readonly eigenvalue: Expression

The eigenvalue this Jordan block belongs to.

JordanDecomposition#

JordanDecomposition.jordanForm#

Raw WebAssembly: JordanDecomposition property

readonly jordanForm: Matrix

The Jordan form J of the decomposed matrix.

Symi documentation · WASM / JavaScript