Struct RootOpts 

pub struct RootOpts {
    pub xtol: f64,
    pub rtol: f64,
    pub max_iter: usize,
}

Options for the scalar root finders brent_root, bisect and newton_root.

use symplex::optimize::RootOpts;

let opts = RootOpts::default();
assert_eq!(opts.xtol, 2e-12);
assert_eq!(opts.rtol, 4.0 * f64::EPSILON);
assert_eq!(opts.max_iter, 100);

Fields

xtol: f64

Absolute tolerance on the root location (default 2e-12).

rtol: f64

Relative tolerance on the root location (default 4·ε).

The bracketing methods stop once the bracket width is at most xtol + rtol·|x|; Newton stops once the step is that small.

max_iter: usize

Maximum number of iterations (default 100). Each iteration costs one function evaluation (plus one derivative evaluation for Newton); the bracketing methods also evaluate the two endpoints up front.

Trait Implementations

impl Clone for RootOpts

fn clone(&self) -> RootOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RootOpts

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

Formats the value using the given formatter.

impl Default for RootOpts

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RootOpts

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RootOpts