scivex-optim 0.1.0

Scivex — Optimization, root finding, and numerical integration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use core::fmt;

/// All errors returned by `scivex-optim`.
#[cfg_attr(
    feature = "serde-support",
    derive(serde::Serialize, serde::Deserialize)
)]
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum OptimError {
    /// An iterative algorithm did not converge within the iteration budget.
    ConvergenceFailure { iterations: usize },

    /// A computation produced a non-finite value (NaN or infinity).
    NonFiniteValue { context: &'static str },

    /// A parameter has an invalid value.
    InvalidParameter {
        name: &'static str,
        reason: &'static str,
    },

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

    /// An error propagated from `scivex-core`.
    CoreError(scivex_core::CoreError),
}

impl fmt::Display for OptimError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::ConvergenceFailure { iterations } => {
                write!(f, "convergence failure after {iterations} iterations")
            }
            Self::NonFiniteValue { context } => {
                write!(f, "non-finite value encountered in {context}")
            }
            Self::InvalidParameter { name, reason } => {
                write!(f, "invalid parameter `{name}`: {reason}")
            }
            Self::BracketError => {
                write!(
                    f,
                    "bracket does not contain a root (f(a) and f(b) must have opposite signs)"
                )
            }
            Self::CoreError(e) => write!(f, "core error: {e}"),
        }
    }
}

impl std::error::Error for OptimError {}

impl From<scivex_core::CoreError> for OptimError {
    fn from(e: scivex_core::CoreError) -> Self {
        Self::CoreError(e)
    }
}

/// Convenience alias used throughout `scivex-optim`.
pub type Result<T> = std::result::Result<T, OptimError>;