Struct SolveTolerance 

pub(crate) struct SolveTolerance {
    pub(crate) residual: f64,
    pub(crate) step: f64,
}

The convergence criteria, relative to the magnitude of what they measure.

Fields

residual: f64

Converged when |f(x) − target| ≤ residual · max(1, |target|).

step: f64

Converged when the step (or half-bracket) ≤ step · max(1, |x|).

Implementations

impl SolveTolerance

fn residual_met(self, residual: f64, target: f64) -> bool

A zero residual tolerance switches the residual criterion off — a solve to the double’s resolution keeps halving through an exact zero rather than stopping at the first iterate that underflows to it.

fn step_met(self, step: f64, x: f64) -> bool

Trait Implementations

impl Clone for SolveTolerance

fn clone(&self) -> SolveTolerance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SolveTolerance

impl Debug for SolveTolerance

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

Formats the value using the given formatter.

impl Default for SolveTolerance

fn default() -> Self

Returns the “default value” for a type.