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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
//! InterpType and Interpolation definitions
use crate::Accelerator;
use crate::{DomainError, InterpolationError};
/// Representation of an Interpolation Type.
pub trait InterpType<T> {
/// The returned Interpolator, containing the calculated coefficients and providing the
/// evaluation methods.
type Interpolation: Interpolation<T> + Send + Sync;
/// Creates an Interpolator from the data arrays `xa` and `ya`.
///
/// # Example
///
/// ```
/// # use rsl_interpolation::*;
///
/// # fn main() -> Result<(), InterpolationError>{
/// let xa = [0.0, 1.0, 2.0];
/// let ya = [0.0, 2.0, 4.0];
/// let interp = Cubic.build(&xa, &ya)?;
/// # Ok(())
/// # }
/// ```
fn build(&self, xa: &[T], ya: &[T]) -> Result<Self::Interpolation, InterpolationError>;
/// Returns the name of the Interpolator.
#[doc(alias = "gsl_interp_name")]
fn name(&self) -> &str;
/// Returns the minimum number of points required by the Interpolator.
#[doc(alias = "gsl_interp_min_size")]
fn min_size(&self) -> usize;
}
/// Defines the required evaluation methods.
pub trait Interpolation<T> {
/// Returns the interpolated value `y` for a given point `x`, using the data arrays `xa` and `ya` and
/// the [`Accelerator`] `acc`.
///
/// # Example
///
/// ```
/// # use rsl_interpolation::*;
/// #
/// # fn main() -> Result<(), InterpolationError>{
/// let xa = [0.0, 1.0, 2.0];
/// let ya = [0.0, 2.0, 4.0];
/// let interp = Cubic.build(&xa, &ya)?;
/// let mut acc = Accelerator::new();
///
/// let y = interp.eval(&xa, &ya, 1.5, &mut acc)?;
///
/// assert_eq!(y, 3.0);
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Returns a [`DomainError`] if `x` is outside the range of `xa`.
#[doc(alias = "gsl_interp_eval")]
#[doc(alias = "gsl_interp_eval_e")]
fn eval(&self, xa: &[T], ya: &[T], x: T, acc: &mut Accelerator) -> Result<T, DomainError>;
/// Returns the derivative `dy/dx` of an interpolated function for a given point `x`, using the
/// data arrays `xa` and `ya` and the [`Accelerator`] `acc`.
///
/// # Example
///
/// ```
/// # use rsl_interpolation::*;
/// #
/// # fn main() -> Result<(), InterpolationError>{
/// let xa = [0.0, 1.0, 2.0];
/// let ya = [0.0, 2.0, 4.0];
/// let interp = Cubic.build(&xa, &ya)?;
/// let mut acc = Accelerator::new();
///
/// let dydx = interp.eval_deriv(&xa, &ya, 1.5, &mut acc)?;
///
/// assert_eq!(dydx, 2.0);
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Returns a [`DomainError`] if `x` is outside the range of `xa`.
#[doc(alias = "gsl_interp_eval_deriv")]
#[doc(alias = "gsl_interp_eval_deriv_e")]
fn eval_deriv(&self, xa: &[T], ya: &[T], x: T, acc: &mut Accelerator)
-> Result<T, DomainError>;
/// Returns the second derivative `d²y/dx²` of an interpolated function for a given point `x`, using the
/// data arrays `xa` and `ya` and the [`Accelerator`] `acc`.
///
/// # Example
///
/// ```
/// # use rsl_interpolation::*;
/// #
/// # fn main() -> Result<(), InterpolationError>{
/// let xa = [0.0, 1.0, 2.0];
/// let ya = [0.0, 2.0, 4.0];
/// let interp = Cubic.build(&xa, &ya)?;
/// let mut acc = Accelerator::new();
///
/// let dydx2 = interp.eval_deriv2(&xa, &ya, 1.5, &mut acc)?;
///
/// assert_eq!(dydx2, 0.0);
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Returns a [`DomainError`] if `x` is outside the range of `xa`.
#[doc(alias = "gsl_interp_eval_deriv2")]
#[doc(alias = "gsl_interp_eval_deriv2_e")]
fn eval_deriv2(
&self,
xa: &[T],
ya: &[T],
x: T,
acc: &mut Accelerator,
) -> Result<T, DomainError>;
#[allow(rustdoc::broken_intra_doc_links)]
/// Returns the numerical integral of an interpolated function over the range [`a` ,`b`], using the
/// data arrays `xa` and `ya` and the [`Accelerator`] `acc`.
///
/// # Example
///
/// ```
/// # use rsl_interpolation::*;
/// #
/// # fn main() -> Result<(), InterpolationError>{
/// let xa = [0.0, 1.0, 2.0];
/// let ya = [0.0, 2.0, 4.0];
/// let interp = Cubic.build(&xa, &ya)?;
/// let mut acc = Accelerator::new();
///
/// let int = interp.eval_integ(&xa, &ya, 0.0, 2.0, &mut acc)?;
///
/// assert_eq!(int, 4.0);
/// # Ok(())
/// # }
/// ```
///
/// # Errors
///
/// Returns a [`DomainError`] if `a` or `b` is outside the range of xa.
#[doc(alias = "gsl_interp_eval_integ")]
#[doc(alias = "gsl_interp_eval_integ_e")]
fn eval_integ(
&self,
xa: &[T],
ya: &[T],
a: T,
b: T,
acc: &mut Accelerator,
) -> Result<T, DomainError>;
}