aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 2a65957a356bbfc91d40d2933a1714f468095fe9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
This is a small C++ dense numerical linear algebra library, with a companion experiments directory 
for evaluating performance.
I mostly follow Trefethen & Bau, "Numerical Linear Algebra" and Golub & Van Loan, "Matrix 
Computations."
The implementation uses `NEON` SIMD on ARM64 systems when available.

### Build

The library is packaged as a C++20 named module (`linalgebra`): 

- CMake 4.1.x
- Ninja
- LLVM Clang ≥ 18 with libc++ (Homebrew LLVM 22 is what's tested; AppleClang
  doesn't yet support module dependency scanning)

```bash
cmake -S . -B build -G Ninja -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++
cmake --build build
```

You can explicitly disable SIMD at configure time with:

```bash
cmake -S . -B build -G Ninja \
  -DCMAKE_CXX_COMPILER=/opt/homebrew/opt/llvm/bin/clang++ \
  -DLINEAR_ALGEBRA_SIMD=NONE
```

Valid values are `AUTO` (uses available SIMD) and `NONE` (forces scalar fallback).

### Usage

Import the module:

```cpp
import linalgebra;

int main() {
    linalgebra::Matrix A{{1.0, 2.0}, {3.0, 4.0}};
    linalgebra::Vector b{5.0, 6.0};
    auto lu = linalgebra::lu_factor(A);
    auto x  = linalgebra::lu_solve(lu, b);
}
```

### Run tests

```bash
ctest --test-dir build --output-on-failure
```

### What's implemented

- Matrix / Vector core with SIMD matmul
- Triangular solvers (forward / backward substitution)
- LU factorization with partial pivoting (`lu_factor`, `lu_solve`)
- QR factorization — classical GS, modified GS, and Householder (`qr_classical_gs`, 
  `qr_modified_gs`, `qr_householder`)
- Rank-revealing QR — Householder with column pivoting (`qr_colpiv`); reports numerical rank
  and ensures |R(i,i)| ≥ |R(i+1,i+1)|
- Eigenvalue computation via QR iteration:
  - Unshifted QR (`eigenvalues_unshifted`) — linear convergence, T&B Algorithm 28.1
  - Wilkinson-shifted QR (`eigenvalues_shifted`) — typically cubic convergence, T&B Lecture 29
  - Hessenberg + Givens QR (`eigenvalues_hessenberg`) — O(n²) per step after one O(n³) reduction; 
    ~10–30× faster than `eigenvalues_shifted` for n ≥ 50
  - Francis double-shift QR (`eigenvalues_francis`) — implicit bulge chasing on Hessenberg form;
    handles complex conjugate eigenvalue pairs without complex arithmetic; robust subdiagonal +
    2×2 block deflation with exceptional shifts (GVL §7.5)
- Cholesky factorization (`cholesky_factor`, `cholesky_solve`) 
- Symmetric tridiagonalization
- Eigenvectors via inverse iteration (eigenvectors_inverse_iteration)
- SVD — Golub-Kahan bidiagonalization + QR (svd)
- Conjugate Gradient (solve_cg)
- GMRES (solve_gmres)
- BiCGSTAB (solve_bicgstab)
- Condition number estimation
- Preconditioners (precond_jacobi, precond_ilu0)
- Least squares solver (lstsq)
- Arnoldi iteration (arnoldi)
- Matrix exponential (expm)