Enum OptimizationError 

pub enum OptimizationError {
    LineSearchFailed {
        iterations: usize,
        step_size: f64,
    },
    NotDescentDirection {
        directional_derivative: f64,
    },
    NotConverged {
        iterations: usize,
        gradient_norm: f64,
    },
    InvalidFunctionValue {
        value: f64,
    },
}

Optimization-related errors.

Variants

LineSearchFailed

Line search failed to find sufficient decrease

Fields

iterations: usize

step_size: f64

NotDescentDirection

Search direction is not a descent direction

Fields

directional_derivative: f64

NotConverged

Optimization did not converge

Fields

iterations: usize

gradient_norm: f64

InvalidFunctionValue

Function evaluation returned NaN or infinity

Fields

value: f64

Trait Implementations

impl Clone for OptimizationError

fn clone(&self) -> OptimizationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptimizationError

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

Formats the value using the given formatter.

impl Display for OptimizationError

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

Formats the value using the given formatter.

impl From<OptimizationError> for NumraError

fn from(e: OptimizationError) -> Self

Converts to this type from the input type.

impl PartialEq for OptimizationError

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