Struct Convergence 

pub struct Convergence {
    pub rtol: R,
    pub atol: R,
    pub dtol: R,
    pub max_iters: usize,
}

Convergence criteria for iterative solvers.

This struct defines four types of stopping criteria:

• Relative tolerance: ‖r‖/‖b‖ ≤ rtol
• Absolute tolerance: ‖r‖ ≤ atol
• Divergence threshold: ‖r‖ ≥ dtol * ‖b‖
• Maximum iterations: iterations ≥ max_iters

Fields

rtol: R

Relative tolerance: ‖r‖/‖b‖ ≤ rtol ⇒ converge

atol: R

Absolute tolerance: ‖r‖ ≤ atol ⇒ converge

dtol: R

Divergence threshold: ‖r‖ ≥ dtol * ‖b‖ ⇒ diverge

max_iters: usize

Maximum iterations

Implementations

impl Convergence

pub fn new(rtol: R, atol: R, dtol: R, max_iters: usize) -> Self

Create new convergence criteria.

pub fn check( &self, rnorm: R, bnorm: R, iters: usize, ) -> (ConvergedReason, SolveStats<R>)

Check convergence/divergence criteria.

Returns (reason, SolveStats) based on current residual norm and iteration count.

Arguments

• rnorm - Current residual norm ‖r‖
• bnorm - Right-hand side norm ‖b‖
• iters - Current iteration count

Returns

Tuple of (ConvergedReason, SolveStats) indicating the stopping reason.

impl Convergence

pub fn check_legacy( &self, res_norm: R, res0_norm: R, i: usize, ) -> (bool, SolveStats<R>)

👎Deprecated since 0.1.0:

use check() method instead

Legacy method for backward compatibility. Returns (should_stop, stats) given current res_norm and iteration i.

Deprecated: Use check() instead for more detailed convergence information.