Struct Criteria 

pub struct Criteria {
    pub residual: f64,
    pub step: f64,
    pub max_iterations: usize,
}

Stopping criteria for an iterative solver.

Fields

residual: f64

Stop when |f(x)| falls to this.

step: f64

Stop when the step falls to this.

max_iterations: usize

Give up after this many iterations.

Implementations

impl Criteria

pub fn with_residual(residual: f64) -> Self

Criteria with a given residual tolerance and the default step limit.

Trait Implementations

impl Clone for Criteria

fn clone(&self) -> Criteria

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Criteria

impl Debug for Criteria

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

Formats the value using the given formatter.

impl Default for Criteria

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Criteria

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