Struct RootResult 

pub struct RootResult<T: Float> {
    pub root: T,
    pub f_root: T,
    pub iterations: usize,
    pub converged: bool,
}

Result of a root-finding algorithm.

Examples

let result = bisection(|x: f64| x * x - 2.0, 1.0, 2.0, &RootOptions::default()).unwrap();
assert!(result.converged);
assert!((result.root - std::f64::consts::SQRT_2).abs() < 1e-10);

Fields

root: T

The estimated root.

f_root: T

The function value at the root: f(root).

iterations: usize

Number of iterations performed.

converged: bool

Whether the algorithm converged within tolerances.

Trait Implementations

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

fn clone(&self) -> RootResult<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 RootResult<T>

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

Formats the value using the given formatter.