rslab (Python bindings)
NumPy/SciPy bindings for RSLAB, a pure-Rust sparse direct solver and preconditioner: complex/real symmetric LDL^T (Bunch-Kaufman), unsymmetric LU, and a KLU-style path for circuit-shaped matrices. A thin wrapper, all numeric work happens in Rust.
Install
pip install rslab
Usage
import numpy as np
import scipy.sparse as sp
import rslab
# Symmetric system (real or complex; the dtype selects the path).
A = sp.random(5000, 5000, density=1e-3, format="csc") + sp.eye(5000) * 10
A = A + A.T
b = np.random.rand(5000)
# One-shot solve.
x = rslab.spsolve(A, b)
# Factor once, solve many right-hand sides.
f = rslab.ldlt(A)
x1 = f.solve(b)
X = f.solve_many(np.random.rand(5000, 8)) # n x nrhs
print(f.n, f.factor_nnz, f.inertia, f.dtype)
Complex-symmetric matrices (EM/FEM, PARDISO mtype 6) work identically:
A = A.astype(np.complex128); A.data += 1j * 0.3 * A.data.real
x = rslab.ldlt(A).solve(np.ones(A.shape[0], dtype=np.complex128))
Unsymmetric matrices use the LU path:
f = rslab.lu(A_general)
x = f.solve(b)
Circuit-shaped matrices (MNA / SPICE-class: very sparse, unsymmetric,
near-triangularizable) use the KLU path, bit-deterministic, with a
numeric-only refactor for fixed-pattern sweeps:
f = rslab.klu(A_circuit)
x = f.solve(b)
A_circuit.data *= 1.5 # frequency sweep: same pattern, new values
f.refactor(A_circuit.data) # no symbolic work, no pivot search
x2 = f.solve(b)
y = f.solve_transpose(b) # A.T @ y = b on the same factors (adjoint)
solve_transpose is the plain transpose; for the conjugate-transpose adjoint
use f.solve_transpose(b.conj()).conj().
Preconditioner mode
Never-fail static pivoting plus iterative refinement for hard/indefinite systems:
f = rslab.ldlt(A, preconditioner=1e-4)
x = f.solve(b, refine=20) # refine against the original A
Configuration (keyword arguments)
By default ldlt, lu and spsolve use RSLAB's deterministic heuristic
pick, the adaptive ordering plus an exact nested-dissection bakeoff on large
systems (adopted only on a clear predicted win with no fill/memory
regression). A one-time rslab.install_diagnose() measures this machine's
throughput and speedup curve and caches it; afterwards the default also picks
its worker count from the calibration (until then the conservative capped
default applies). Keyword arguments override the pick:
| kwarg | default | meaning |
|---|---|---|
threads |
None (auto) |
None = calibrated/structural per-matrix pick; int = fixed (0 = all) |
preconditioner |
None |
static-pivot floor (e.g. 1e-4); never-fail, refine to solve |
drop_tol |
None |
incomplete-factor threshold (preconditioner) |
method |
"left_looking" |
"left_looking" or "multifrontal" |
memory |
"low" |
"low" or "eager" factor emit strategy |
force_accept |
False |
accept tiny pivots in exact mode instead of failing |
klu accepts:
| kwarg | default | meaning |
|---|---|---|
pivot_tol |
1e-3 |
diagonal-preference threshold; 1.0 = plain partial pivoting |
row_scaling |
True |
divide each row by its max-magnitude entry before factoring |
btf |
True |
permute to block upper triangular form first (keep it on) |
parallel |
None |
per-block parallel factor/refactor over the BTF blocks; None = auto gate (>=4 blocks, >=8000 nnz, no dominant block), True/False force on/off; bit-identical result in every mode |
Supported dtypes: float64, float32, complex128, complex64.
API
Everything ships in the flat rslab namespace; full parameter documentation
lives in the docstrings (help(rslab.klu) etc.).
Functions
| function | meaning |
|---|---|
spsolve(A, b, **kw) |
one-shot factor-and-solve; detects symmetry and picks the LDL^T or LU path |
ldlt(A, **kw) -> Ldlt |
factor a real/complex symmetric matrix (Bunch-Kaufman LDL^T) |
lu(A, **kw) -> Lu |
factor a general unsymmetric matrix (supernodal multifrontal LU) |
klu(A, **kw) -> Klu |
factor a circuit-shaped matrix (BTF + per-block Gilbert-Peierls LU) |
install_diagnose() |
one-time machine calibration; caches the measured thread-speedup curve |
Factor handles - factor once, then:
| method / attribute | Ldlt |
Lu |
Klu |
meaning |
|---|---|---|---|---|
solve(b, refine=0) |
yes | yes | yes | solve one RHS, optional iterative-refinement steps against the original A |
solve_many(B) |
yes | yes | yes | solve n x nrhs RHS in one batched pass |
solve_transpose(b) |
- | - | yes | solve A^T y = b on the same factors (plain transpose, not conjugate) |
refactor(data) |
- | - | yes | numeric-only re-factorization for new values on the same pattern (no symbolic work, no pivot search) |
gmres(b, tol=1e-8, maxit=400, restart=None, x0=None, recycle=None) |
yes | yes | yes | GMRES with this factor as preconditioner |
gmres_block(B, tol=1e-8, maxit=400, restart=None, x0=None) |
yes | yes | yes | block GMRES for multiple RHS |
recycle(k) |
yes | yes | yes | a Recycle workspace holding up to k deflation vectors across gmres calls |
n, factor_nnz, n_perturbed, dtype |
yes | yes | yes | dimension, stored factor entries, perturbed pivots (always 0 for Klu), NumPy dtype name |
inertia |
yes | - | - | (n_pos, n_neg, n_zero) eigenvalue counts from LDL^T |
n_blocks |
- | - | yes | number of BTF diagonal blocks |
Recycle - deflation-subspace carrier for sweeps: attributes k,
active, dtype; clear() resets it.
License
MIT.
1 maintainer
Release files for rslab 0.31.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rslab-0.31.0.tar.gz | 1.2 MB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| rslab-0.31.0-cp39-abi3-win_amd64.whl | CPython 3.9 | abi3 | Windows x86-64 | Details |
| rslab-0.31.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.9 | abi3 | Linux glibc 2.17+ x86-64 | Details |
| rslab-0.31.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl | CPython 3.9 | abi3 | Linux glibc 2.17+ ARM64 | Details |
| rslab-0.31.0-cp39-abi3-macosx_11_0_arm64.whl | CPython 3.9 | abi3 | macOS 11.0+ ARM64 | Details |
| rslab-0.31.0-cp39-abi3-macosx_10_12_x86_64.whl | CPython 3.9 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 11.8 MB
Release files / rslab-0.31.0.tar.gz
| Download URL | rslab-0.31.0.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b9da5c3c3b75c9b4882ea97e84bbbe6231fac0ee751c3299bd2dc516d7a7cc7b
|
|
BLAKE2b-256 checksum How to use checksums |
28791b9d7e9b94efce716c899ce7e16f4893023b0258f05ac698fbde193845ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / rslab-0.31.0-cp39-abi3-win_amd64.whl
| Download URL | rslab-0.31.0-cp39-abi3-win_amd64.whl |
|---|---|
| Size | 2.1 MB |
| Tags | CPython 3.9 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
05c1d9129d4310f2714b6754f2f2a173d553f9fd6b728d6b824a5f49d0a8bf02
|
|
BLAKE2b-256 checksum How to use checksums |
5882381e4b5e6bb7b49639a7b523381f4475bccae9880dafe30e434377061104
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / rslab-0.31.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | rslab-0.31.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 2.4 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
a291dca24d74a0033febc570f5e26354b407bdd264ecc2bd33b8959ea0ba9424
|
|
BLAKE2b-256 checksum How to use checksums |
64e12c2d221044542ae03511d43ed7d2f2984996a6c77351ad6d56b481c23b7f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / rslab-0.31.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | rslab-0.31.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 2.1 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
a77a7b155964e593b924e73e099e4571533cbb3a27d138cab54311f7be210337
|
|
BLAKE2b-256 checksum How to use checksums |
6854139cbdf3cc09b8e3a6cdfce8912ca93feec6f304cb19af07faecb434d6b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / rslab-0.31.0-cp39-abi3-macosx_11_0_arm64.whl
| Download URL | rslab-0.31.0-cp39-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 1.9 MB |
| Tags | CPython 3.9 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
839259d4e7b2814baca2f385cc14add25f09be8a35072d7a6d26bbb93e38b87e
|
|
BLAKE2b-256 checksum How to use checksums |
883d451c3e3af7e018dbd9e2073973de280ee31c836d964cbbc20930982bed92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / rslab-0.31.0-cp39-abi3-macosx_10_12_x86_64.whl
| Download URL | rslab-0.31.0-cp39-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 2.1 MB |
| Tags | CPython 3.9 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
c0c7336aa3f43c59eac96b5b1470ea012e9df03fd0ab6c41d8ac719563aa97b8
|
|
BLAKE2b-256 checksum How to use checksums |
90eecd9ab29a2d1b822b0888454b01c40c29afd26476bb529ea51c139c056ed8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency log
