varpro 0.14.0

A straightforward nonlinear least-squares fitting library which uses the Variable Projection algorithm.
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

use thiserror::Error as ThisError;

/// Errors pertaining to use errors of the [crate::model::SeparableModel].
#[derive(Debug, Clone, ThisError, PartialEq, Eq)]
pub enum ModelError {
    /// Base functions are expected to return a vector the same length as the location argument.
    /// A function did not adhere to that rule.
    #[error(
        "Base function gave vector of length {}, but expected output length was {}",
        actual_length,
        expected_length
    )]
    UnexpectedFunctionOutput {
        /// the expected length
        expected_length: usize,
        /// the actual length
        actual_length: usize,
    },

    /// Indicates an evaluation for a parameter was requested that is not part of the model parameters
    #[error("Parameter '{}' is not in model", parameter)]
    ParameterNotInModel {
        /// the parameter that was not part of the model
        parameter: String,
    },

    /// Indicates that the given derivative index is out of bounds.
    #[error("Index {} for derivative is out of bounds", index)]
    DerivativeIndexOutOfBounds {
        /// the index of the derivative out of bounds
        index: usize,
    },

    /// It was tried to evaluate a model with an incorrect number of parameters
    #[error("Model expects {} parameters, but got {}", expected, actual)]
    IncorrectParameterCount {
        /// the number of parameters that are required for the model
        expected: usize,
        /// the given number of parameters
        actual: usize,
    },
}