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.
Matrix canonical forms
Canonical and integer forms return structured decompositions when metadata such
as transformations, rank, pivots, or invariant factors is part of the result.
Every decomposition on this page carries the transformation matrices that
certify it, so the defining identity can be replayed exactly.
Ordinary matrix arithmetic, determinants, and spectral data are on
linear algebra; the shape of each returned record is
listed in structured results and the generated
result-type index.
Raw WebAssembly: Matrix method
rationalCanonicalForm(variable: string): RationalCanonicalForm
Returns the certified Frobenius canonical form over the rationals. Its invariant factors are
monic and ordered by divisibility, and similarity satisfies
matrixsimilarity=similaritycanonical_form exactly.
Not exposed by the WASM / JavaScript bindings. Available as Matrix.rational_canonical_form in Python, UniffiMatrix.rationalCanonicalForm in Kotlin, UniffiMatrix.rationalCanonicalForm in Swift, api::matrix_operations::Matrix::rational_canonical_form in Rust.
Not exposed by the WASM / JavaScript bindings. Available as RationalCanonicalForm.canonical_form in Python, UniffiRationalCanonicalForm.canonicalForm in Kotlin, UniffiRationalCanonicalForm.canonicalForm in Swift, api::results::RationalCanonicalForm::canonical_form in Rust.
invariant_factors#
Not exposed by the WASM / JavaScript bindings. Available as RationalCanonicalForm.invariant_factors in Python, UniffiRationalCanonicalForm.invariantFactors in Kotlin, UniffiRationalCanonicalForm.invariantFactors in Swift, api::results::RationalCanonicalForm::invariant_factors in Rust.
The similarity, minimal_polynomial, and characteristic_polynomial getters return the
corresponding certified fields documented by their shared headings above.
Raw WebAssembly: Matrix method
hermiteNormalForm(): HermiteNormalFormDecomposition
Returns the canonical row-oriented Hermite normal form H, a unimodular
transformation U satisfying UM=H, the rank, and the strictly increasing
pivot-column indices. Entries must be exact integers. Every result is verified
for Hermite shape, the certificate identity, and unimodularity before return.
Notes: WASM returns a HermiteNormalFormDecomposition object with the
getters documented below.
Raw WebAssembly: Matrix method
columnHermiteNormalForm(): HermiteNormalFormDecomposition
The transpose-dual column form, returning H, a unimodular V satisfying
MV=H, the rank, and pivot metadata. Notes: WASM returns a
HermiteNormalFormDecomposition object.
Raw WebAssembly: Matrix method
smithNormalForm(): SmithNormalFormDecomposition
Returns the canonical integer Smith normal form D, unimodular transformations
U and V satisfying UMV=D, the rank, and the invariant factors including
trailing zeros. The nonnegative positive prefix is divisibility-ordered. Every
result is verified for diagonal shape, divisibility, the exact certificate, and
unimodularity of both transformations before return. Notes: WASM returns a
SmithNormalFormDecomposition object with the getters documented below.
integer_cokernel_structure#
Raw WebAssembly: Matrix method
integerCokernelStructure(): IntegerCokernelData
Returns the free rank and nontrivial torsion invariant factors of
Z^m / M Z^n. Notes: WASM returns an IntegerCokernelData object.
smith#
Raw WebAssembly: SmithNormalFormDecomposition property
The Smith normal form S.
Not exposed by the WASM / JavaScript bindings. Available as UniffiSmithNormalFormDecomposition.rowTransformation in Kotlin, UniffiSmithNormalFormDecomposition.rowTransformation in Swift, api::results::SmithNormalFormDecomposition::row_transformation in Rust.
Not exposed by the WASM / JavaScript bindings. Available as UniffiSmithNormalFormDecomposition.columnTransformation in Kotlin, UniffiSmithNormalFormDecomposition.columnTransformation in Swift, api::results::SmithNormalFormDecomposition::column_transformation in Rust.
smith_invariant_factors#
free_rank#
torsion_invariant_factors#
integer_kernel_basis#
Raw WebAssembly: Matrix method
integerKernelBasis(): Matrix[]
A canonical basis of the integer kernel {x∈Zn:Mx=0}, returned as
column matrices.
integer_row_lattice_basis#
Raw WebAssembly: Matrix method
integerRowLatticeBasis(): Matrix[]
The nonzero rows of the row Hermite form, returned as row matrices; these form
the canonical basis of the integer row lattice.
integer_image_lattice_basis#
Raw WebAssembly: Matrix method
integerImageLatticeBasis(): Matrix[]
The nonzero columns of the column Hermite form, returned as column matrices;
these form the canonical basis of M Z^n.
hermite#
Raw WebAssembly: HermiteNormalFormDecomposition property
The Hermite normal form H.
Raw WebAssembly: HermiteNormalFormDecomposition property
readonly transformation: Matrix
pivot_columns#
Not exposed by the WASM / JavaScript bindings. Available as UniffiHermiteNormalFormDecomposition.pivotColumns in Kotlin, UniffiHermiteNormalFormDecomposition.pivotColumns in Swift, api::results::HermiteNormalFormDecomposition::pivot_columns in Rust.
The rank getter reuses the matrix rank heading above.
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#
Raw WebAssembly: HermiteNormalFormDecomposition property
readonly pivotColumns: Uint32Array
The rank getter reuses the matrix rank heading above.
Raw WebAssembly: HermiteNormalFormDecomposition property
Rank via Bareiss fraction-free elimination.
Raw WebAssembly: RationalCanonicalForm property
readonly canonicalForm: Matrix
The Frobenius canonical form of the decomposed matrix.
Raw WebAssembly: RationalCanonicalForm property
readonly characteristicPolynomial: Expression
det(λI−M) as a polynomial in the named variable.
Raw WebAssembly: RationalCanonicalForm property
readonly invariantFactors: Expression[]
The certified invariant factors, monic and ordered by divisibility.
Raw WebAssembly: RationalCanonicalForm property
readonly minimalPolynomial: Expression
The monic minimal polynomial over the rationals. The matrix must have rational entries.
Raw WebAssembly: RationalCanonicalForm property
readonly similarity: Matrix
The certified change of basis S, satisfying matrix * S == S * canonical_form.
Raw WebAssembly: SmithNormalFormDecomposition property
readonly columnTransformation: Matrix
The unimodular column transformation V satisfying U * matrix * V == S.
Raw WebAssembly: SmithNormalFormDecomposition property
readonly invariantFactors: Expression[]
The certified invariant factors, monic and ordered by divisibility.
Raw WebAssembly: SmithNormalFormDecomposition property
Rank via Bareiss fraction-free elimination.
Raw WebAssembly: SmithNormalFormDecomposition property
readonly rowTransformation: Matrix
The unimodular row transformation U satisfying U * matrix * V == S.