solvr 0.2.0-beta.2

Advanced computing library for real-world problem solving - optimization, differential equations, interpolation, statistics, and more
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

//! Scalar (1D) root finding and minimization algorithms.
//!
//! This module provides methods for finding roots and minima of univariate functions.
//! Root finding methods require a function `f: (f64) -> f64`.
//! Most methods are bracketing (require an interval [a, b] where f(a)*f(b) < 0).

mod minimization;
mod root_finding;

pub use minimization::{minimize_scalar_bounded, minimize_scalar_brent, minimize_scalar_golden};
pub use root_finding::{bisect, brentq, newton, ridder, secant};

/// Options for scalar root finding and minimization.
#[derive(Debug, Clone)]
pub struct ScalarOptions {
    /// Maximum number of iterations
    pub max_iter: usize,
    /// Absolute tolerance for convergence (root value)
    pub tol: f64,
    /// Relative tolerance for convergence (width of interval)
    pub rtol: f64,
}

impl Default for ScalarOptions {
    fn default() -> Self {
        Self {
            max_iter: 100,
            tol: 1e-12,
            rtol: 1e-12,
        }
    }
}

/// Result from a root finding method.
#[derive(Debug, Clone)]
pub struct RootResult {
    /// The root found
    pub root: f64,
    /// Function value at root
    pub function_value: f64,
    /// Number of iterations used
    pub iterations: usize,
    /// Final bracket width (for bracketing methods)
    pub bracket_width: f64,
}

/// Result from a minimization method.
#[derive(Debug, Clone)]
pub struct MinimizeResult {
    /// The minimum point found
    pub x: f64,
    /// Function value at minimum
    pub f_min: f64,
    /// Number of iterations used
    pub iterations: usize,
    /// Final bracket width (for bracketing methods)
    pub bracket_width: f64,
}