Skip to content
Symi Docs
Kotlin
On this page

Matrix functions and Jordan form

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

exponential#

UniffiMatrix method

fun exponential(): UniffiMatrix

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

logarithm#

UniffiMatrix method

fun logarithm(): UniffiMatrix

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

square_root#

UniffiMatrix method

fun squareRoot(): UniffiMatrix

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#

UniffiMatrix method

fun sine(): UniffiMatrix

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#

UniffiMatrix method

fun cosine(): UniffiMatrix

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

hyperbolic_sine#

UniffiMatrix method

fun hyperbolicSine(): UniffiMatrix

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#

UniffiMatrix method

fun hyperbolicCosine(): UniffiMatrix

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

jordan_decomposition#

UniffiMatrix method

fun jordanDecomposition(): UniffiJordanDecomposition

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)#

UniffiMatrix method

fun jordanDecomposition(): UniffiJordanDecomposition

similarity#

UniffiJordanDecomposition method

fun similarity(): UniffiMatrix

jordan_form#

UniffiJordanDecomposition method

fun jordanForm(): UniffiMatrix

The Jordan form J of the decomposed matrix.

blocks#

UniffiJordanDecomposition method

fun blocks(): List<UniffiJordanBlock>

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.

UniffiJordanBlock method

fun size(): kotlin.ULong

The size of this Jordan block.

Example#

Additional API#

JordanBlock#

JordanBlock.eigenvalue#

UniffiJordanBlock method

fun eigenvalue(): UniffiExpression

The eigenvalue this Jordan block belongs to.

Symi documentation · Kotlin