nalgebra-sparse-linalg 0.1.10

Sparse linear algebra library for Rust using nalgebra including linear solvers and SVD.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

/// Preconditioners for linear algebra solvers.
pub type LinAlgResult<T> = Result<T, LinAlgError>;

#[derive(Debug)]
pub enum LinAlgError {
    Singular,
    NotSPD,
    DimensionMismatch,
    Internal(String),
}

pub trait Preconditioner<M, V> {
    fn build(a: &M) -> Result<Self, &'static str>
    where
        Self: Sized;

    fn apply_left(&self, v: &mut V);     // Approx. solves M⁻¹ * v
    fn apply_right(&self, v: &mut V);    // Approx. solves M⁻¹ applied on the right (optional)
}


pub struct IdentityPreconditioner;

impl<M, V> Preconditioner<M, V> for IdentityPreconditioner {
    fn build(_a: &M) -> Result<Self, &'static str> {
        Ok(IdentityPreconditioner)
    }

    fn apply_left(&self, _v: &mut V) {}
    fn apply_right(&self, _v: &mut V) {}
}