rsl-interpolation 0.1.19

A re-write of GSL's Interpolation Routines in Rust.
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

#[derive(thiserror::Error, Debug)]
/// The error type for Interpolator creation and data checking.
pub enum InterpolationError {
    /// x points dataset is not sorted.
    #[error("x values must be strictly increasing.")]
    UnsortedDataset,

    /// x and y datasets have different length.
    #[error("Supplied datasets must be 1D and of equal length.")]
    DatasetMismatch,

    /// Supplied array size is less than the interpolation type's minimum size.
    #[error("Supplied array size is less than the interpolation type's minimum size.")]
    NotEnoughPoints,

    /// Supplied z-grid dataset must be 1D with length of `xsize*ysize`.
    #[error("Supplied z-grid dataset must be 1D with length of `xsize*ysize`.")]
    ZGridMismatch,

    /// BLAS error solving Tridiagonal linear system.
    #[error("BLAS error solving Tridiagonal matrix of {which_interp} Interpolator: {source}")]
    BLASTridiagError {
        which_interp: String,
        #[source]
        source: ndarray_linalg::error::LinalgError,
    },

    /// Supplied value is outside the range of the supplied xdata.
    #[error("{0}")]
    Domain1dError(#[from] Domain1dError),

    /// Supplied value is outside the range of the supplied xdata or ydata.
    #[error("{0}")]
    Domain2dError(#[from] Domain2dError),
}

/// Returned when the supplied value is outside the range of the supplied xdata.
#[derive(thiserror::Error, Debug)]
#[error("1D Interpolation domain error: x = {x}")]
pub struct Domain1dError {
    pub x: f64,
}

/// Returned  when the supplied value is outside the range of the supplied xdata or ydata.
#[derive(thiserror::Error, Debug)]
#[error("1D Interpolation domain error: x = {x}, y = {y}")]
pub struct Domain2dError {
    pub x: f64,
    pub y: f64,
}