Crate rlst 

The Rust linear solver toolbox (RLST).

The purpose of this library is to provide a comprehensive set of tools for dense and sparse linear algebra operations required in the solution of partial differential equations and other problems. RLST has the following feature set.

• n-dimensional array structures that can be allocated on the stack or heap.
• BLAS matrix multiplication and LAPACK decompositions, eigenproblems, and matrix equations.
• CSR sparse matrices on one node or distributed with MPI, plus optional UMFPACK solves through the companion rlst-suitesparse crate.
• Matrix Market import and export.
• Abstract linear operators and iterative solvers.
• Optional FFTW transforms and Burn tensor conversion.

To learn about the features of RLST please have a look at the following documents.

• Getting started with RLST
• Changelog and migration notes
• An introduction to dense linear algebra with RLST
• Matrix decompositions
• Sparse matrix operations
• Abstract linear algebra and iterative solvers
• MPI distributed computations
• Optional FFTW and Burn integrations
• Interpolation utilities

Re-exports

pub use crate::dense::array::Array;

pub use crate::dense::array::empty_array;

pub use dense::array::DynArray;

pub use dense::array::SliceArray;

pub use dense::array::SliceArrayMut;

pub use dense::array::StridedDynArray;

pub use dense::array::ZeroDimArray;

pub use traits::*;

pub use base_types::*;

Modules

base_types

Basic types.

dense

Dense array types and operations on them.

doc

The RLST documentation.

interface

Interfaces to other libraries

interpolation

Functions to evaluate interpolation polynomials.

io

The io library provides import and export routines for various file formats.

operator

The operator library contains traits and methods to support arbitrary operator types.

simd

Basic traits for SIMD Operations

sparse

RLST sparse

threading

BLAS threading control.

tracing

Simple structures to trace execution times of functions.

traits

Traits used by RLST.

Macros

assert_array_abs_diff_eq

Assert that the absolute difference of two arrays is small enough

assert_array_relative_eq

Assert that the relative difference of two arrays is small enough

assert_matrix_abs_diff_eq

Assert that the absolute difference of two matrices is small enough

assert_matrix_relative_eq

Assert that the relative difference of two matrices is small enough

assert_matrix_ulps_eq

TODO: document

diag

Create a new n-dimensional diagonal array from a list of diagonal entries.

dot

Allocate a direct contraction of the last axis of a with the first of b.

dot_blas

BLAS-backed multiplication between compatible dense arrays.

dot_into

Contract the last axis of a with the first axis of b, overwriting c.

linspace

Create an array of n equidistant points with first value a and second value b.

println_mpi

A println function that is MPI aware and outputs only on rank 0.

rlst_dynamic_array

Allocate a dynamic column-major RLST array.

rlst_static_array

Create a stack-backed column-major RLST array.

rlst_static_type

Expand to the type of a stack-backed RLST array.

Constants

CACHE_ALIGNED

Align memory along cache lines

FFTW_ALIGNED

Align memory for FFTW. FFTW requires 16 bytes alignment

PAGE_ALIGNED

Align memory along page lines

Attribute Macros

measure_duration

Instrument a function with entry, exit, and elapsed-time log messages.