Struct Spai 

pub struct Spai<I, T> { /* private fields */ }

Sparse approximate inverse: M^{-1} = M ~= A^{-1}.

Stores M in CSC. Apply is a single sparse matvec with no triangular solves. See the module documentation for guidance.

Implementations

impl<I: Index, T: ComplexField> Spai<I, T>

pub fn try_new( a: SparseColMatRef<'_, I, T>, pattern: SpaiPattern, ) -> Result<Self, SpaiError>

Build a SPAI preconditioner for A.

Errors

• SpaiError::NonSquareMatrix if A is not square.
• SpaiError::InvalidPower if a ColumnsOfPower power is zero.

impl<I, T> Spai<I, T>

pub fn dim(&self) -> usize

Dimension n of the preconditioner.

Trait Implementations

impl<I, T> BiLinOp<T> for Spai<I, T>

where I: Index, T: ComplexField + Debug + Sync,

fn transpose_apply_scratch(&self, _rhs_ncols: usize, _par: Par) -> StackReq

computes the workspace layout required to apply the transpose or adjoint o self to a matrix with rhs_ncols columns

fn transpose_apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par, _stack: &mut MemStack, )

applies the transpose of self to rhs, and stores the result in out

fn adjoint_apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par, _stack: &mut MemStack, )

applies the adjoint of self to rhs, and stores the result in out

impl<I, T> BiPrecond<T> for Spai<I, T>

where I: Index, T: ComplexField + Debug + Sync,

fn transpose_apply_in_place_scratch( &self, rhs_ncols: usize, _par: Par, ) -> StackReq

computes the workspace layout required to apply the transpose or adjoint of self to a matrix with rhs_ncols columns in place

fn transpose_apply_in_place( &self, rhs: MatMut<'_, T>, par: Par, stack: &mut MemStack, )

applies the transpose of self to rhs, and stores the result in rhs

fn adjoint_apply_in_place( &self, rhs: MatMut<'_, T>, par: Par, stack: &mut MemStack, )

applies the adjoint of self to rhs, and stores the result in rhs

impl<I: Clone, T: Clone> Clone for Spai<I, T>

fn clone(&self) -> Spai<I, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Debug, T: Debug> Debug for Spai<I, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I, T> LinOp<T> for Spai<I, T>

where I: Index, T: ComplexField + Debug + Sync,

fn apply_scratch(&self, _rhs_ncols: usize, _par: Par) -> StackReq

computes the workspace layout required to apply self or the conjugate o self to a matrix with rhs_ncols columns

fn nrows(&self) -> usize

output dimension of the operator

fn ncols(&self) -> usize

input dimension of the operator

fn apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par, _stack: &mut MemStack, )

applies self to rhs, and stores the result in out

fn conj_apply( &self, out: MatMut<'_, T>, rhs: MatRef<'_, T>, par: Par, _stack: &mut MemStack, )

applies the conjugate of self to rhs, and stores the result in out

impl<I, T> Precond<T> for Spai<I, T>

where I: Index, T: ComplexField + Debug + Sync,

fn apply_in_place_scratch(&self, rhs_ncols: usize, _par: Par) -> StackReq

computes the workspace layout required to apply self or the conjugate of self to a matrix with rhs_ncols columns in place

fn apply_in_place(&self, rhs: MatMut<'_, T>, par: Par, stack: &mut MemStack)

applies self to rhs, and stores the result in rhs

fn conj_apply_in_place( &self, rhs: MatMut<'_, T>, par: Par, stack: &mut MemStack, )

applies the conjugate of self to rhs, and stores the result in rhs