Struct SolverUMFPACK 

pub struct SolverUMFPACK { /* private fields */ }

Wraps the UMFPACK solver for sparse linear systems

Warning: This solver may “run out of memory” for very large matrices.

Implementations

impl SolverUMFPACK

pub fn new() -> Result<Self, StrError>

Allocates a new instance

Trait Implementations

impl Drop for SolverUMFPACK

fn drop(&mut self)

Tells the c-code to release memory

impl LinSolTrait for SolverUMFPACK

fn factorize( &mut self, mat: &CooMatrix, params: Option<LinSolParams>, ) -> Result<(), StrError>

Performs the factorization (and analysis/initialization if needed)

Input

• mat – the coefficient matrix A. The matrix must be square (nrow = ncol) and, if symmetric, the symmetric flag must be Sym::YesFull
• params – configuration parameters; None => use default

Notes

1. The structure of the matrix (nrow, ncol, nnz, sym) must be exactly the same among multiple calls to factorize. The values may differ from call to call, nonetheless.
2. The first call to factorize will define the structure which must be kept the same for the next calls.
3. If the structure of the matrix needs to be changed, the solver must be “dropped” and a new solver allocated.
4. For symmetric matrices, UMFPACK requires Sym::YesFull

fn solve( &mut self, x: &mut Vector, rhs: &Vector, verbose: bool, ) -> Result<(), StrError>

Computes the solution of the linear system

Solves the linear system:

  A   · x = rhs
(m,m)  (m)  (m)

Output

• x – the vector of unknown values with dimension equal to mat.nrow

Input

• mat – the coefficient matrix A; it must be square and, if symmetric, Sym::YesFull.
• rhs – the right-hand side vector with know values an dimension equal to mat.nrow
• verbose – shows messages

Warning: the matrix must be same one used in factorize.

fn update_stats(&self, stats: &mut StatsLinSol)

Updates the stats structure (should be called after solve)

fn get_ns_init(&self) -> u128

Returns the nanoseconds spent on initialize

fn get_ns_fact(&self) -> u128

Returns the nanoseconds spent on factorize

fn get_ns_solve(&self) -> u128

Returns the nanoseconds spent on solve

impl Send for SolverUMFPACK

Enforce Send on the Rust structure

https://stackoverflow.com/questions/50258359/can-a-struct-containing-a-raw-pointer-implement-send-and-be-ffi-safe