Struct SolvePrecond 

pub struct SolvePrecond<S> { /* private fields */ }

Adapter exposing a faer factorisation S as a preconditioner.

See the module documentation for the intended use. S is any factorisation implementing SolveCore (Llt, Ldlt, Lu, Qr, …).

Implementations

impl<S> SolvePrecond<S>

pub fn new(solver: S) -> Self

Wrap a factorisation as a preconditioner.

pub fn inner(&self) -> &S

Borrow the wrapped factorisation.

pub fn into_inner(self) -> S

Unwrap and return the factorisation.

Trait Implementations

impl<T, S> BiLinOp<T> for SolvePrecond<S>

where T: ComplexField, S: ShapeCore + SolveCore<T> + Sync + Debug,

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<T, S> BiPrecond<T> for SolvePrecond<S>

where T: ComplexField, S: ShapeCore + SolveCore<T> + Sync + Debug,

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<S: Clone> Clone for SolvePrecond<S>

fn clone(&self) -> SolvePrecond<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for SolvePrecond<S>

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

Formats the value using the given formatter.

impl<T, S> LinOp<T> for SolvePrecond<S>

where T: ComplexField, S: ShapeCore + SolveCore<T> + Sync + Debug,

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<T, S> Precond<T> for SolvePrecond<S>

where T: ComplexField, S: ShapeCore + SolveCore<T> + Sync + Debug,

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