scirs2_sparse::incomplete_factorizations

Struct Ic0

pub struct Ic0<F> { /* private fields */ }

Expand description

IC(0) preconditioner: Incomplete Cholesky factorization with zero fill-in.

For symmetric positive definite (SPD) matrices. Computes a lower triangular matrix L such that A ~ L * L^T, retaining only the sparsity pattern of the lower triangle of A.

Implementations§

Source §

impl<F> Ic0<F>
where F: Float + NumAssign + Sum + SparseElement + Debug + 'static,

Source

pub fn new(matrix: &CsrMatrix<F>) -> SparseResult<Self>

Construct an IC(0) preconditioner from an SPD CSR matrix.

Only the lower triangular part (including diagonal) is used.

§Errors

Returns an error if the matrix is not square, or if the factorization encounters a non-positive pivot (matrix is not SPD).

Trait Implementations§

Source §

impl<F> Preconditioner<F> for Ic0<F>
where F: Float + NumAssign + Sum + SparseElement + Debug + 'static,

Source §

fn apply(&self, r: &Array1<F>) -> SparseResult<Array1<F>>

Apply M^{-1} r = L^{-T} L^{-1} r.

Auto Trait Implementations§

§

impl<F> UnwindSafe for Ic0<F>
where F: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §