libmat-rs 0.1.1

Rust bindings for libmat, an stb-style single-header linear algebra library in pure C
Documentation 
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

# libmat-rs

Rust bindings for [libmat](https://github.com/alvgaona/libmat), an stb-style single-header
linear algebra library in pure C.

## Usage

Add to your `Cargo.toml`:

```toml
[dependencies]
libmat-rs = "0.1"
```

```rust
use libmat_rs::Mat;

let a = Mat::from_slice(2, 2, &[1.0, 2.0, 3.0, 4.0]);
let b = Mat::eye(2);
let c = a.mul(&b);

let eig = a.eigen_sym();
```

Matrices use **column-major** storage (BLAS-compatible).

## API

| Function | Description |
|----------|-------------|
| `Mat::new(rows, cols)` | Zero-initialized matrix |
| `Mat::from_slice(rows, cols, data)` | Matrix from column-major slice |
| `Mat::eye(dim)` | Identity matrix |
| `mat.mul(other)` | Matrix multiplication |
| `mat.add(other)` | Element-wise addition |
| `mat.at(row, col)` | Element access |
| `mat.eigvals()` | Eigenvalues (general) |
| `mat.eigvals_sym()` | Eigenvalues (symmetric) |
| `mat.eigen()` | Eigendecomposition (general) |
| `mat.eigen_sym()` | Eigendecomposition (symmetric) |

## Coverage

This crate exposes a subset of libmat's functionality. The underlying C library supports many
more operations (SVD, Cholesky, QR, LU, solvers, norms, SIMD kernels, etc.) that are not yet
wrapped. Contributions are welcome.

## License

Apache-2.0