solvr 0.2.0

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

//! Generic implementations of least squares algorithms.
use crate::DType;

mod bounded;
mod leastsq;

pub use bounded::least_squares_impl;
pub use leastsq::leastsq_impl;

use numr::runtime::Runtime;
use numr::tensor::Tensor;

/// Result from tensor-based least squares optimization.
#[derive(Debug, Clone)]
pub struct TensorLeastSquaresResult<R: Runtime<DType = DType>> {
    /// The optimal parameters found
    pub x: Tensor<R>,
    /// Residual vector at solution
    pub residuals: Tensor<R>,
    /// Sum of squared residuals (cost)
    pub cost: f64,
    /// Number of iterations
    pub iterations: usize,
    /// Number of function evaluations
    pub nfev: usize,
    /// Whether the method converged
    pub converged: bool,
}