Skip to main content

ConjugateGradientSolver

Struct ConjugateGradientSolver 

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

Conjugate Gradient solver for symmetric positive-definite sparse systems.

Stores the solver configuration (tolerance, iteration cap, preconditioning). The solve itself is stateless and may be invoked concurrently on different inputs from multiple threads.

Implementations§

Source§

impl ConjugateGradientSolver

Source

pub fn new( tolerance: f64, max_iterations: usize, use_preconditioner: bool, ) -> Self

Create a new CG solver.

§Arguments
  • tolerance – Relative residual threshold for convergence. Must be positive and finite.
  • max_iterations – Upper bound on CG iterations. Must be >= 1.
  • use_preconditioner – Enable diagonal (Jacobi) preconditioning.
Source

pub fn tolerance(&self) -> f64

Return the configured tolerance.

Source

pub fn max_iterations(&self) -> usize

Return the configured maximum iterations.

Source

pub fn use_preconditioner(&self) -> bool

Return whether preconditioning is enabled.

Trait Implementations§

Source§

impl Clone for ConjugateGradientSolver

Source§

fn clone(&self) -> ConjugateGradientSolver

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConjugateGradientSolver

Source§

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

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

impl SolverEngine for ConjugateGradientSolver

Source§

fn solve( &self, matrix: &CsrMatrix<f64>, rhs: &[f64], budget: &ComputeBudget, ) -> Result<SolverResult, SolverError>

Solve Ax = b using the Conjugate Gradient method.

§Errors
Source§

fn estimate_complexity( &self, profile: &SparsityProfile, n: usize, ) -> ComplexityEstimate

Estimate CG complexity from the sparsity profile.

CG converges in O(sqrt(kappa)) iterations, each costing O(nnz) for the SpMV plus O(n) for the vector updates.

Source§

fn algorithm(&self) -> Algorithm

Return the algorithm identifier.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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 = 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more