Struct RootOptions 

pub struct RootOptions<T: Float> {
    pub xtol: T,
    pub ftol: T,
    pub max_iter: usize,
}

Options controlling root-finding algorithms.

Examples

let opts = RootOptions {
    xtol: 1e-8,
    ftol: 1e-8,
    max_iter: 50,
};
let result = bisection(|x: f64| x * x - 2.0, 1.0, 2.0, &opts).unwrap();
assert!(result.converged);

Fields

xtol: T

Tolerance on the root position.

ftol: T

Tolerance on the function value.

max_iter: usize

Maximum number of iterations.

Trait Implementations

impl<T: Clone + Float> Clone for RootOptions<T>

fn clone(&self) -> RootOptions<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Float> Debug for RootOptions<T>

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

Formats the value using the given formatter.

impl<T: Float> Default for RootOptions<T>

fn default() -> Self

Returns the “default value” for a type.