Struct Root

pub struct Root {
    pub x: f64,
    pub value: f64,
    pub lower: f64,
    pub upper: f64,
    pub iterations: usize,
    pub evaluations: usize,
    pub status: Status,
}

A root located inside a sign-change bracket.

Fields

x: f64

Best estimate: the bracket end with the smaller |f|.

value: f64

f(x).

lower: f64

Lower end of the final bracket.

upper: f64

Upper end of the final bracket. The function changes sign across [lower, upper], or lower == upper == x with value == 0.

iterations: usize

Iterations performed.

evaluations: usize

Function evaluations performed.

status: Status

Status::Converged, or Status::BudgetExhausted if the iteration cap was hit first; the bracket is valid either way.

Implementations

impl Root

pub fn error_bound(&self) -> f64

A bound on |x - root|: the final bracket width.

Trait Implementations

impl Clone for Root

fn clone(&self) -> Root

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Root

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

Formats the value using the given formatter.

impl PartialEq for Root

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

impl StructuralPartialEq for Root