Skip to main content

ChebyshevPreconditioner

Struct ChebyshevPreconditioner 

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

Chebyshev polynomial preconditioner with automatic eigenvalue estimation.

Constructs p(A) ~ A^{-1} where p is a degree-d Chebyshev polynomial optimally scaled to the spectrum [lambda_min, lambda_max].

Application proceeds via the three-term Chebyshev recurrence, requiring degree sparse matrix-vector products per application.

Implementations§

Source§

impl ChebyshevPreconditioner

Source

pub fn from_csr( csr: &CsrMatrix<f64>, config: &PolyPrecondConfig, ) -> SparseResult<Self>

Build a Chebyshev preconditioner from a CSR matrix.

Eigenvalue bounds are estimated automatically using a few Lanczos steps.

§Arguments
  • csr - The SPD sparse matrix in CSR format.
  • config - Configuration parameters.
Source

pub fn with_bounds( csr: &CsrMatrix<f64>, degree: usize, lambda_min: f64, lambda_max: f64, ) -> SparseResult<Self>

Build a Chebyshev preconditioner with explicit eigenvalue bounds.

§Arguments
  • csr - The SPD sparse matrix in CSR format.
  • degree - Polynomial degree (5-20 recommended).
  • lambda_min - Lower bound on the eigenvalue spectrum.
  • lambda_max - Upper bound on the eigenvalue spectrum.
Source

pub fn apply(&self, r: &[f64]) -> SparseResult<Vec<f64>>

Apply the Chebyshev polynomial preconditioner: z = p(A) * r.

Uses the Chebyshev iteration three-term recurrence. This computes an approximation to A^{-1} r without constructing any matrix.

Source

pub fn eigenvalue_bounds(&self) -> (f64, f64)

Return the estimated eigenvalue bounds.

Source

pub fn degree(&self) -> usize

Return the polynomial degree.

Source

pub fn size(&self) -> usize

Return the matrix dimension.

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> 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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V