Struct Iluk 

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

Numeric ILU(k) factor of a CSC matrix A.

Holds the L/U value buffers, the symbolic structure and the dense workspace used during refactorisation. Iluk::refactorize performs zero heap allocations.

Implementations

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

pub fn new_with_symbolic(symbolic: SymbolicIluk<I>) -> Self

Allocate the value buffers and dense workspace for a symbolic factor.

pub fn try_new( a: SparseColMatRef<'_, I, T>, level: usize, ) -> Result<Self, IlukError>

Build a fully populated ILU(k) factor from a CSC matrix A.

pub fn dim(&self) -> usize

Dimension n of the factored matrix.

pub fn symbolic(&self) -> &SymbolicIluk<I>

Borrow the symbolic factor.

pub fn refactorize( &mut self, a: SparseColMatRef<'_, I, T>, ) -> Result<(), IlukError>

Refactorise against a new matrix with the same sparsity pattern.

Performs zero heap allocations.

Errors

• IlukError::PatternMismatch if a’s shape disagrees with the symbolic structure.
• IlukError::ZeroPivot if a pivot of magnitude zero is encountered.

pub fn l_view(&self) -> SparseColMatRef<'_, I, T>

View over the L factor (unit lower triangular, diagonal first).

pub fn u_view(&self) -> SparseColMatRef<'_, I, T>

View over the U factor (upper triangular, diagonal last).

Trait Implementations

impl<I, T> BiLinOp<T> for Iluk<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 Iluk<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 Iluk<I, T>

fn clone(&self) -> Iluk<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 Iluk<I, T>

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

Formats the value using the given formatter.

impl<I, T> LinOp<T> for Iluk<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 Iluk<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