Struct LevenbergMarquardtOptions

pub struct LevenbergMarquardtOptions {
    pub gradient_tolerance: f64,
    pub step_tolerance: f64,
    pub cost_tolerance: f64,
    pub max_iterations: usize,
}

Stopping rules and budget for levenberg_marquardt.

Fields

gradient_tolerance: f64

Stop when ||J^T r||_inf is at most this.

step_tolerance: f64

Stop when a step is at most this times ||x|| + step_tolerance.

cost_tolerance: f64

Stop when the cost 1/2 ||r||^2 is at most this (for zero-residual problems such as equation systems; 0 disables).

max_iterations: usize

Most iterations (accepted or rejected steps).

Implementations

impl LevenbergMarquardtOptions

pub fn new(tolerance: f64) -> Self

Gradient and step tolerance tolerance, no cost tolerance, at most 500 iterations.

Trait Implementations

impl Clone for LevenbergMarquardtOptions

fn clone(&self) -> LevenbergMarquardtOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LevenbergMarquardtOptions

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

Formats the value using the given formatter.

impl PartialEq for LevenbergMarquardtOptions

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

impl StructuralPartialEq for LevenbergMarquardtOptions