faier 0.25.0

linear algebra library — maintained fork of faer with AI-assisted fixes
Documentation

faier — faer, with AI-assisted fixes

About this fork. faier is a maintained fork of faer by Sarah Quiñones, used by geode-fem and related projects. Upstream does not accept contributions written with AI assistance. Our development uses AI tools, so fixes we need cannot go upstream, and we carry them here instead.

  • Same API, with two sparse-factorization exceptions. The package is named faier, but the library name is still faer, so existing code keeps use faer::.... faier 0.25 is based on faer 0.24.4 and differs from its API in two places: sparse LU's factorize_symbolic_lu takes a column-ordering argument (pass LuColOrdering::Colamd for faer's behaviour), and sparse QR's column_counts_ata takes the matrix A instead of its transpose. See Using faier below.
  • Tracks upstream. The fork follows upstream releases and adds a small set of fixes, each listed in FORK.md with the issue it resolves.
  • License and credit. faer is MIT-licensed. The original copyright, license and third-party notices are retained, and all credit for faer itself belongs to its author.
  • Report fork bugs here, at rjwalters/faier, not upstream.

Using faier

Rename the package in your Cargo.toml and keep the faer dependency key, so your code is unchanged:

[dependencies]
faer = { package = "faier", version = "0.25" }
use faer::Mat;

Not yet on crates.io. The crates.io form above works only once faier has been published (tracked in #3). Until then, and for fixes that are on main but not yet released, use the git form:

[dependencies]
faer = { package = "faier", git = "https://github.com/rjwalters/faier" }
# or pin it: add `rev = "<commit>"` (or `branch = "main"`)

If you depend on faer-traits directly, rename that too; its library name is still faer_traits:

faer-traits = { package = "faier-traits", version = "0.24" }

The list of changes this fork carries on top of upstream, each with the issue it resolves, is in FORK.md.

Citation. CITATION.cff and paper.md describe upstream faer-rs and credit its author; please cite upstream. This fork is a derivative work.

The upstream README follows. Its badges and documentation links point at the upstream faer crate, which does not include this fork's fixes.


faer

upstream faer documentation upstream faer crate (upstream faer)

faer is a rust crate that implements low level linear algebra routines and a high level wrapper for ease of use, in pure rust. the aim is to provide a fully featured library for linear algebra with focus on portability, correctness, and performance.

see the upstream official website and the upstream docs.rs documentation for code examples and usage instructions.

questions about using the library, contributing, and future directions can be discussed in the zulip server.

contributing

if you'd like to contribute to faer, check out the list of "good first issue" issues. these are all (or should be) issues that are suitable for getting started, and they generally include a detailed set of instructions for what to do. please ask questions on the zulip server or the issue itself if anything is unclear!

minimum supported rust version

the current msrv is rust 1.84.0.

benchmarks

see the benchmark page on the main website.