## sprs

A sparse matrix library

### 33 releases

 0.10.0 Mar 18, 2021 Dec 19, 2020 Oct 13, 2020 Jul 27, 2020 Jul 3, 2015

#5 in Science

Used in 21 crates (15 directly)

MIT/Apache

435KB
10K SLoC

# sprs, sparse matrices for Rust

sprs implements some sparse matrix data structures and linear algebra algorithms in pure Rust.

The API is a work in progress, and feedback on its rough edges is highly appreciated :)

## Features

### Structures

• CSR/CSC matrix
• triplet matrix
• Sparse vector

### Operations

• sparse matrix / sparse vector product
• sparse matrix / sparse matrix product
• sparse matrix / sparse matrix addition, subtraction
• sparse vector / sparse vector addition, subtraction, dot product
• sparse/dense matrix operations

### Algorithms

• Outer iterator on compressed sparse matrices
• sparse vector iteration
• sparse vectors joint non zero iterations
• simple sparse Cholesky decomposition (requires opting into an LGPL license)
• sparse triangular solves with dense right-hand side

## Examples

Matrix construction

``````  use sprs::{CsMat, CsMatOwned, CsVec};
let eye : CsMatOwned<f64> = CsMat::eye(3);
let a = CsMat::new_csc((3, 3),
vec![0, 2, 4, 5],
vec![0, 1, 0, 2, 2],
vec![1., 2., 3., 4., 5.]);
``````

Matrix vector multiplication

``````  use sprs::{CsMat, CsVec};
let eye = CsMat::eye(5);
let x = CsVec::new(5, vec![0, 2, 4], vec![1., 2., 3.]);
let y = &eye * &x;
assert_eq!(x, y);
``````

``````  use sprs::{CsMat, CsVec};
let eye = CsMat::eye(3);
let a = CsMat::new_csc((3, 3),
vec![0, 2, 4, 5],
vec![0, 1, 0, 2, 2],
vec![1., 2., 3., 4., 5.]);
let b = &eye * &a;
assert_eq!(a, b.to_csr());
``````

For a more complete example, be sure to check out the heat diffusion example.

## Documentation

Documentation is available at docs.rs.

## Changelog

See the changelog.

## Minimum Supported Rust Version

The minimum supported Rust version currently is 1.42. Prior to a 1.0 version, bumping the MSRV will not be considered a breaking change, but breakage will be avoided on a best effort basis.