Enum Convergence 

pub enum Convergence {
    Residual,
    Step,
    Exhausted,
}

How a solver finished.

Variants

Residual

The residual fell below the requested tolerance.

Step

The step size fell below the requested tolerance.

Exhausted

The iteration limit was reached first. The result is the best estimate found, and is not to be treated as a root.

Implementations

impl Convergence

pub const fn is_converged(self) -> bool

Whether the solver actually converged.

Trait Implementations

impl Clone for Convergence

fn clone(&self) -> Convergence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Convergence

impl Debug for Convergence

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

Formats the value using the given formatter.

impl Eq for Convergence

impl PartialEq for Convergence

fn eq(&self, other: &Convergence) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Convergence