Struct ConvergenceState 

pub struct ConvergenceState {
    pub iteration: usize,
    pub converged: bool,
    pub diverged: bool,
    pub residual_history: Vec<f64>,
    pub damping_history: Vec<f64>,
    pub consecutive_converged: usize,
}

Current state of convergence tracking.

Fields

iteration: usize

Current iteration count.

converged: bool

Whether the algorithm has converged.

diverged: bool

Whether the algorithm has diverged.

residual_history: Vec<f64>

History of residual values per iteration.

damping_history: Vec<f64>

History of damping values per iteration.

consecutive_converged: usize

Number of consecutive iterations below tolerance.

Implementations

impl ConvergenceState

pub fn new() -> Self

Create a fresh convergence state.

pub fn latest_residual(&self) -> Option<f64>

Return the most recent residual value, if any.

pub fn convergence_rate(&self) -> Option<f64>

Compute the convergence rate as the ratio of the last two residuals.

Returns None if fewer than two residuals have been recorded.

Trait Implementations

impl Clone for ConvergenceState

fn clone(&self) -> ConvergenceState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvergenceState

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

Formats the value using the given formatter.

impl Default for ConvergenceState

fn default() -> Self

Returns the “default value” for a type.