csaps 0.5.0

Cubic spline approximation (smoothing)
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use ndarray::{ArrayView, ArrayView1, Dimension};

use crate::validate::{validate_data_sites, validate_smooth_value};
use crate::{CsapsError::InvalidInputData, Real, Result};

use super::GridCubicSmoothingSpline;

impl<'a, T, D> GridCubicSmoothingSpline<'a, T, D>
where
    T: Real<T>,
    D: Dimension,
{
    pub(super) fn make_validate(&self) -> Result<()> {
        validate_xy(&self.x, self.y.view())?;
        validate_weights(&self.x, &self.weights)?;
        validate_smooth(&self.x, &self.smooth)?;

        Ok(())
    }

    pub(super) fn evaluate_validate(&self, xi: &[ArrayView1<'a, T>]) -> Result<()> {
        let x_len = self.x.len();
        let xi_len = xi.len();

        if xi_len != x_len {
            return Err(InvalidInputData(format!(
                "The number of `xi` vectors ({}) is not equal to the number of dimensions ({})",
                xi_len, x_len
            )));
        }

        for xi_ax in xi.iter() {
            if xi_ax.is_empty() {
                return Err(InvalidInputData(
                    "The sizes of `xi` vectors must be greater or equal to 1".to_string(),
                ));
            }
        }

        Ok(())
    }
}

pub(super) fn validate_xy<T, D>(x: &[ArrayView1<'_, T>], y: ArrayView<'_, T, D>) -> Result<()>
where
    T: Real<T>,
    D: Dimension,
{
    if x.len() != y.ndim() {
        return Err(InvalidInputData(format!(
            "The number of `x` data site vectors ({}) is not equal to `y` data dimensionality ({})",
            x.len(),
            y.ndim()
        )));
    }

    for (ax, (&xi, &ys)) in x.iter().zip(y.shape().iter()).enumerate() {
        let xi_len = xi.len();

        if xi_len < 2 {
            return Err(InvalidInputData(format!(
                "The size of `x` site vectors must be greater or equal to 2, axis {}",
                ax
            )));
        }

        validate_data_sites(xi.view())?;

        if xi_len != ys {
            return Err(InvalidInputData(format!(
                "`x` data sites vector size ({}) is not equal to `y` data size ({}) for axis {}",
                xi_len, ys, ax
            )));
        }
    }

    Ok(())
}

pub(super) fn validate_weights<T>(
    x: &[ArrayView1<'_, T>],
    w: &[Option<ArrayView1<'_, T>>],
) -> Result<()>
where
    T: Real<T>,
{
    let x_len = x.len();
    let w_len = w.len();

    if w_len != x_len {
        return Err(InvalidInputData(format!(
            "The number of `weights` vectors ({}) is not equal to the number of dimensions ({})",
            w_len, x_len
        )));
    }

    for (ax, (xi, wi)) in x.iter().zip(w.iter()).enumerate() {
        if let Some(wi_view) = wi {
            let xi_len = xi.len();
            let wi_len = wi_view.len();

            if wi_len != xi_len {
                return Err(InvalidInputData(format!(
                    "`weights` vector size ({}) is not equal to `x` vector size ({}) for axis {}",
                    wi_len, xi_len, ax
                )));
            }
        }
    }

    Ok(())
}

pub(super) fn validate_smooth<T>(x: &[ArrayView1<'_, T>], smooth: &[Option<T>]) -> Result<()>
where
    T: Real<T>,
{
    let x_len = x.len();
    let s_len = smooth.len();

    if s_len != x_len {
        return Err(InvalidInputData(format!(
            "The number of `smooth` values ({}) is not equal to the number of dimensions ({})",
            s_len, x_len
        )));
    }

    for (ax, s_opt) in smooth.iter().enumerate() {
        if let Some(s) = s_opt {
            if let Err(err) = validate_smooth_value(*s) {
                return Err(InvalidInputData(format!("{} for axis {}", err, ax)));
            };
        }
    }

    Ok(())
}