Trait russell_sparse::ComplexLinSolTrait

source ·

pub trait ComplexLinSolTrait {
    // Required methods
    fn factorize(
        &mut self,
        mat: &mut ComplexSparseMatrix,
        params: Option<LinSolParams>
    ) -> Result<(), StrError>;
    fn solve(
        &mut self,
        x: &mut ComplexVector,
        mat: &ComplexSparseMatrix,
        rhs: &ComplexVector,
        verbose: bool
    ) -> Result<(), StrError>;
    fn update_stats(&self, stats: &mut StatsLinSol);
    fn get_ns_init(&self) -> u128;
    fn get_ns_fact(&self) -> u128;
    fn get_ns_solve(&self) -> u128;
}

Expand description

Defines a unified interface for complex linear system solvers

Required Methods§

source

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

Performs the factorization (and analysis/initialization if needed)

§Input

mat – The sparse matrix (COO, CSC, or CSR).
params – configuration parameters; None => use default

§Notes

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.
The first call to factorize will define the structure which must be kept the same for the next calls.
If the structure of the matrix needs to be changed, the solver must be “dropped” and a new solver allocated.

source