Struct ScalarMinimum

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

A local minimum of a scalar function on an interval.

Fields

x: f64

The minimiser estimate.

value: f64

f(x).

lower: f64

Lower end of the final bracket.

upper: f64

Upper end of the final bracket. If f is unimodal on the starting interval, the minimiser lies in [lower, upper].

iterations: usize

Iterations performed.

evaluations: usize

Function evaluations performed.

status: Status

How the search stopped.

Implementations

impl ScalarMinimum

pub fn error_bound(&self) -> f64

A bound on |x - minimiser| for a unimodal function: the final bracket width.

pub fn converged(self) -> NumericResult<Self>

The minimum if the tolerance was met.

Errors

NumericError::NotConverged with the bracket width reached.

Trait Implementations

impl Clone for ScalarMinimum

fn clone(&self) -> ScalarMinimum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarMinimum

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

Formats the value using the given formatter.

impl PartialEq for ScalarMinimum

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

impl StructuralPartialEq for ScalarMinimum