Enum ConvergenceStatus 

pub enum ConvergenceStatus {
    NotConverged,
    Converged(ConvergenceReason),
}

Result of a convergence check

Variants

NotConverged

Algorithm has not converged

Converged(ConvergenceReason)

Algorithm has converged with a reason

Implementations

impl ConvergenceStatus

pub fn is_converged(&self) -> bool

Check if converged

Trait Implementations

impl Clone for ConvergenceStatus

fn clone(&self) -> ConvergenceStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvergenceStatus

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

Formats the value using the given formatter.

impl PartialEq for ConvergenceStatus

fn eq(&self, other: &ConvergenceStatus) -> 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 Eq for ConvergenceStatus

impl StructuralPartialEq for ConvergenceStatus