Struct JacobiPreconditioner

Source

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

Expand description

Jacobi (diagonal) preconditioner.

Uses M = diag(A), so M^{-1} r = r ./ diag(A). Effective when the matrix is diagonally dominant.

Implementations§

Source §

impl<F: Float + SparseElement + Debug> JacobiPreconditioner<F>

Source

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

Create a Jacobi preconditioner from a CSR matrix.

Returns an error if any diagonal element is zero or near-zero.

Source

pub fn from_diagonal(diagonal: Array1<F>) -> SparseResult<Self>

Create a Jacobi preconditioner from an explicit diagonal vector.

Trait Implementations§

Source §

impl<F: Float + SparseElement> Preconditioner<F> for JacobiPreconditioner<F>

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 JacobiPreconditioner<F>
where F: RefUnwindSafe,

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 §