Enum RootError 

pub enum RootError<E> {
    Eval(E),
    ExactRootDegenerate {
        at: f64,
    },
    DegenerateDerivative {
        at: f64,
        derivative: f64,
    },
    BracketInvalid {
        lo: f64,
        hi: f64,
    },
    BracketNoStraddle {
        f_lo: f64,
        f_hi: f64,
    },
    BracketingExhausted {
        direction: f64,
        seed: f64,
    },
    ConvergedRootDegenerate {
        at: f64,
    },
}

Error returned by find_root_monotone. Generic over the oracle’s own error type E, which is surfaced verbatim through RootError::Eval.

Variants

Eval(E)

The oracle returned an error at the given point.

ExactRootDegenerate

|F(seed)| <= tol already, but F'(seed) is zero / non-finite, so the derivative the caller needs is degenerate.

Fields

at: f64

The seed point.

DegenerateDerivative

F'(seed) is zero / non-finite away from a root, so no monotone direction can be inferred.

Fields

at: f64

The seed point.

derivative: f64

The offending derivative value.

BracketInvalid

A supplied analytic bracket was invalid (non-finite or lo == hi).

Fields

lo: f64

The bracket endpoints.

hi: f64

The bracket endpoints.

BracketNoStraddle

A supplied analytic bracket did not straddle zero.

Fields

f_lo: f64

F(lo).

f_hi: f64

F(hi).

BracketingExhausted

Geometric bracketing exhausted max_bracket_iters (or the step cap) without straddling the root.

Fields

direction: f64

The search direction (+1 or -1).

seed: f64

The seed point.

ConvergedRootDegenerate

Refinement converged in a but |F'| at the best point is zero / non-finite, so the reported derivative would be degenerate.

Fields

at: f64

The converged point.

Trait Implementations

impl<E: Clone> Clone for RootError<E>

fn clone(&self) -> RootError<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for RootError<E>

impl<E: Debug> Debug for RootError<E>

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

Formats the value using the given formatter.

impl<E: Display> Display for RootError<E>

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

Formats the value using the given formatter.

impl<E: Display + Debug> Error for RootError<E>

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<E: PartialEq> PartialEq for RootError<E>

fn eq(&self, other: &RootError<E>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<E: PartialEq> StructuralPartialEq for RootError<E>