Skip to main content

JacobiOperatorPreconditioner

Struct JacobiOperatorPreconditioner 

Source
pub struct JacobiOperatorPreconditioner { /* private fields */ }
Expand description

Diagonal (Jacobi) preconditioning built from any LinearOperator: z[i] = r[i] / A[i][i].

Stores the reciprocal diagonal, so applying it is one multiply per row. Cannot break down: a diagonal entry whose magnitude is below 1e-300 is treated as 1.0, matching crate::krylov::JacobiPreconditioner.

§Units

The stored reciprocals carry the inverse of whatever units the matrix entries had; treated as dimensionless f64 here.

Implementations§

Source§

impl JacobiOperatorPreconditioner

Source

pub fn new<A: LinearOperator + ?Sized>(a: &A) -> Self

Extract and invert the diagonal of a.

Cost: one LinearOperator::diagonal call plus n divisions.

Source

pub fn reciprocal_diagonal(&self) -> &[f64]

The stored reciprocal diagonal 1 / A[i][i], length n.

Trait Implementations§

Source§

impl Clone for JacobiOperatorPreconditioner

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JacobiOperatorPreconditioner

Source§

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

Formats the value using the given formatter. Read more
Source§

impl OperatorPreconditioner for JacobiOperatorPreconditioner

Source§

fn apply(&self, r: &[f64], z: &mut [f64])

Write z = M^{-1} r. Both slices have the system length; z is fully overwritten.

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.