Enum OptimError 

#[non_exhaustive]
pub enum OptimError {
    ConvergenceFailure {
        iterations: usize,
    },
    NonFiniteValue {
        context: &'static str,
    },
    InvalidParameter {
        name: &'static str,
        reason: &'static str,
    },
    BracketError,
    CoreError(CoreError),
}

All errors returned by scivex-optim.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ConvergenceFailure

An iterative algorithm did not converge within the iteration budget.

Fields

iterations: usize

NonFiniteValue

A computation produced a non-finite value (NaN or infinity).

Fields

context: &'static str

InvalidParameter

A parameter has an invalid value.

Fields

name: &'static str

reason: &'static str

BracketError

The bracket does not contain a root (signs are not opposite).

CoreError(CoreError)

An error propagated from scivex-core.

Trait Implementations

impl Clone for OptimError

fn clone(&self) -> OptimError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptimError

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

Formats the value using the given formatter.

impl Display for OptimError

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

Formats the value using the given formatter.

impl Error for OptimError

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 From<CoreError> for OptimError

fn from(e: CoreError) -> Self

Converts to this type from the input type.

impl PartialEq for OptimError

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