Skip to main content

Crate la_stack

Crate la_stack 

Source
Expand description

Β§la-stack

DOI Crates.io Downloads License Docs.rs CI rust-clippy analyze codecov Audit dependencies Codacy Security Scan

Fast, stack-allocated linear algebra for fixed dimensions in Rust.

This crate grew from the need to support delaunay with fast, stack-allocated linear algebra primitives and algorithms while keeping the API intentionally small and explicit.

Β§πŸ“ Introduction

la-stack provides a handful of const-generic, stack-backed building blocks:

  • Vector<const D: usize> for fixed-length vectors ([f64; D] today)
  • Matrix<const D: usize> for fixed-size square matrices ([[f64; D]; D] today)
  • Lu<const D: usize> for LU factorization with partial pivoting (solve + det)
  • Ldlt<const D: usize> for LDLT factorization without pivoting (solve + det; symmetric SPD/PSD)

§✨ Design goals

  • βœ… Copy types where possible
  • βœ… Const-generic dimensions (no dynamic sizes)
  • βœ… const fn where possible (compile-time evaluation of determinants, dot products, etc.)
  • βœ… Explicit algorithms (LU, solve, determinant)
  • βœ… Robust geometric predicates via optional exact arithmetic (det_sign_exact)
  • βœ… No runtime dependencies by default (optional features may add deps)
  • βœ… Stack storage only (no heap allocation in core types)
  • βœ… unsafe forbidden

See CHANGELOG.md for details.

§🚫 Anti-goals

Β§πŸ”’ Scalar types

Today, the core types are implemented for f64. The intent is to support f32 and f64 (and f128 if/when Rust gains a stable primitive for it). Arbitrary-precision arithmetic is available via the optional "exact" feature (see below).

Β§πŸš€ Quickstart

Add this to your Cargo.toml:

[dependencies]
la-stack = "0.2.1"

Solve a 5Γ—5 system via LU:

use la_stack::prelude::*;

// This system requires pivoting (a[0][0] = 0), so it's a good LU demo.
// A = J - I: zeros on diagonal, ones elsewhere.
let a = Matrix::<5>::from_rows([
    [0.0, 1.0, 1.0, 1.0, 1.0],
    [1.0, 0.0, 1.0, 1.0, 1.0],
    [1.0, 1.0, 0.0, 1.0, 1.0],
    [1.0, 1.0, 1.0, 0.0, 1.0],
    [1.0, 1.0, 1.0, 1.0, 0.0],
]);

let b = Vector::<5>::new([14.0, 13.0, 12.0, 11.0, 10.0]);

let lu = a.lu(DEFAULT_PIVOT_TOL).unwrap();
let x = lu.solve_vec(b).unwrap().into_array();

// Floating-point rounding is expected; compare with a tolerance.
let expected = [1.0, 2.0, 3.0, 4.0, 5.0];
for (x_i, e_i) in x.iter().zip(expected.iter()) {
    assert!((*x_i - *e_i).abs() <= 1e-12);
}

Compute a determinant for a symmetric SPD matrix via LDLT (no pivoting).

For symmetric positive-definite matrices, LDL^T is essentially a square-root-free form of the Cholesky decomposition (you can recover a Cholesky factor by absorbing sqrt(D) into L):

use la_stack::prelude::*;

// This matrix is symmetric positive-definite (A = L*L^T) so LDLT works without pivoting.
let a = Matrix::<5>::from_rows([
    [1.0, 1.0, 0.0, 0.0, 0.0],
    [1.0, 2.0, 1.0, 0.0, 0.0],
    [0.0, 1.0, 2.0, 1.0, 0.0],
    [0.0, 0.0, 1.0, 2.0, 1.0],
    [0.0, 0.0, 0.0, 1.0, 2.0],
]);

let det = a.ldlt(DEFAULT_SINGULAR_TOL).unwrap().det();
assert!((det - 1.0).abs() <= 1e-12);

§⚑ Compile-time determinants (D ≀ 4)

det_direct() is a const fn providing closed-form determinants for D=0–4, using fused multiply-add where applicable. Matrix::<0>::zero().det_direct() returns Some(1.0) (the empty-product convention). For D=1–4, cofactor expansion bypasses LU factorization entirely. This enables compile-time evaluation when inputs are known:

use la_stack::prelude::*;

// Evaluated entirely at compile time β€” no runtime cost.
const DET: Option<f64> = {
    let m = Matrix::<3>::from_rows([
        [2.0, 0.0, 0.0],
        [0.0, 3.0, 0.0],
        [0.0, 0.0, 5.0],
    ]);
    m.det_direct()
};
assert_eq!(DET, Some(30.0));

The public det() method automatically dispatches through the closed-form path for D ≀ 4 and falls back to LU for D β‰₯ 5 β€” no API change needed.

Β§πŸ”¬ Exact determinant sign ("exact" feature)

The default build has zero runtime dependencies. Enable the optional exact Cargo feature to add det_sign_exact(), which returns the provably correct sign (βˆ’1, 0, or +1) of the determinant using adaptive-precision arithmetic (this pulls in num-bigint and num-rational for BigRational):

[dependencies]
la-stack = { version = "0.2.1", features = ["exact"] }
β“˜
use la_stack::prelude::*;

let m = Matrix::<3>::from_rows([
    [1.0, 2.0, 3.0],
    [4.0, 5.0, 6.0],
    [7.0, 8.0, 9.0],
]);
assert_eq!(m.det_sign_exact().unwrap(), 0); // exactly singular

For D ≀ 4, a fast f64 filter (error-bounded det_direct()) resolves the sign without allocating. Only near-degenerate or large (D β‰₯ 5) matrices fall through to the exact Bareiss algorithm in BigRational.

§🧩 API at a glance

TypeStoragePurposeKey methods
Vector<D>[f64; D]Fixed-length vectornew, zero, dot, norm2_sq
Matrix<D>[[f64; D]; D]Fixed-size square matrixfrom_rows, zero, identity, lu, ldlt, det, det_direct, det_sign_exactΒΉ
Lu<D>Matrix<D> + pivot arrayFactorization for solves/detsolve_vec, det
Ldlt<D>Matrix<D>Factorization for symmetric SPD/PSD solves/detsolve_vec, det

Storage shown above reflects the current f64 implementation.

ΒΉ Requires features = ["exact"].

Β§πŸ“‹ Examples

The examples/ directory contains small, runnable programs:

  • solve_5x5 β€” solve a 5Γ—5 system via LU with partial pivoting
  • det_5x5 β€” determinant of a 5Γ—5 matrix via LU
  • const_det_4x4 β€” compile-time 4Γ—4 determinant via det_direct()
  • exact_sign_3x3 β€” exact determinant sign of a near-singular 3Γ—3 matrix (requires exact feature)
just examples
# or individually:
cargo run --example solve_5x5
cargo run --example det_5x5
cargo run --example const_det_4x4
cargo run --features exact --example exact_sign_3x3

§🀝 Contributing

A short contributor workflow:

cargo install just
just setup        # install/verify dev tools + sync Python deps
just check        # lint/validate (non-mutating)
just fix          # apply auto-fixes (mutating)
just ci           # lint + tests + examples + bench compile

For the full set of developer commands, see just --list and AGENTS.md.

Β§πŸ“ Citation

If you use this library in academic work, please cite it using CITATION.cff (or GitHub’s β€œCite this repository” feature). A Zenodo DOI will be added for tagged releases.

Β§πŸ“š References

For canonical references to the algorithms used by this crate, see REFERENCES.md.

Β§πŸ“Š Benchmarks (vs nalgebra/faer)

LU solve (factor + solve): median time vs dimension

Raw data: docs/assets/bench/vs_linalg_lu_solve_median.csv

Summary (median time; lower is better). The β€œla-stack vs nalgebra/faer” columns show the % time reduction relative to each baseline (positive = la-stack faster):

Dla-stack median (ns)nalgebra median (ns)faer median (ns)la-stack vs nalgebrala-stack vs faer
22.0454.415136.731+53.7%+98.5%
314.81924.399181.334+39.3%+91.8%
427.79553.803210.662+48.3%+86.8%
547.76074.257273.875+35.7%+82.6%
8135.473165.778364.931+18.3%+62.9%
16599.219581.478887.069-3.1%+32.4%
322,656.9642,761.9042,864.295+3.8%+7.2%
6417,288.91313,794.76612,324.896-25.3%-40.3%

Β§πŸ“„ License

BSD 3-Clause License. See LICENSE.

ModulesΒ§

prelude
Common imports for ergonomic usage.

StructsΒ§

Ldlt
LDLT factorization (A = L D Lα΅€) for symmetric positive (semi)definite matrices.
Lu
LU decomposition (PA = LU) with partial pivoting.
Matrix
Fixed-size square matrix DΓ—D, stored inline.
Vector
Fixed-size vector of length D, stored inline.

EnumsΒ§

LaError
Linear algebra errors.

ConstantsΒ§

DEFAULT_PIVOT_TOL
Default absolute pivot magnitude threshold used for LU pivot selection / singularity detection.
DEFAULT_SINGULAR_TOL
Default absolute threshold used for singularity/degeneracy detection.