scirs2_sparse::incomplete_factorizations

Struct Ilut

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

Expand description

ILUT preconditioner: Incomplete LU with threshold-based dropping.

Entries smaller than tau * ||row_i|| are dropped, and at most max_fill additional entries per row are kept. This gives a good balance between fill-in and accuracy.

Implementations§

Source §

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

Source

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

Construct an ILUT preconditioner from a CSR matrix.

§Arguments

matrix - Square sparse matrix in CSR format
config - ILUT configuration (drop tolerance and max fill)

Trait Implementations§

Source §

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

Source §

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

Apply the preconditioner to vector r, returning M^{-1} r.

Auto Trait Implementations§

§

impl<F> UnwindSafe for Ilut<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 §