add boundary conditions for CubicSpline interpolator

CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.5.0
+ - update `BuilderError` 
+   - combine variants `DimensionError` and `AxisLenght` into `ShapeError`
+   - add `ValueError` variant
+ - update `CubicSpline` stragegie
+   - Move `CubicSpline` interpolator to `interp1d::cubic_spline` module
+   - add extrapolation
+   - add not-a-knot boundary condition
+   - add clamped boundary condition
+   - add periodic boundary condition
+   - make not-a-knot boundary condition the default
+   - allow any first or second derivative as boundary condition
+ - fix typo `Biliniar` -> `Bilinear`
+
 # 0.4.1
  - major performance improvement for `interp_scalar()` methods ~-50%
  - keywords and categorys in crate metadata
@@ -37,7 +51,7 @@ logarithmic spaced values.
  - updated package structure
  - replaced Interp1DStrategy enum with individual structs
  - added Strategy and StrategyBuilder trait
- - added QubicSpline strategy
+ - added CubicSpline strategy
  - added traits for custom strategies
 
 # 0.1.1

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ndarray-interp"
-version = "0.4.1"
+version = "0.5.0"
 edition = "2021"
 license = "MIT"
 description = "Interpolation package for ndarray"

src/interp1d.rs

@@ -10,7 +10,7 @@
 //!
 //! # Strategies
 //!  - [`Linear`] Linear interpolation strategy
-//!  - [`CubicSpline`] Cubic spline interpolation strategy
+//!  - [`cubic_spline`] Cubic spline interpolation strategy
 
 use std::{any::TypeId, fmt::Debug, ops::Sub};
 
@@ -30,7 +30,14 @@ use crate::{
 mod aliases;
 mod strategies;
 pub use aliases::*;
-pub use strategies::{CubicSpline, Interp1DStrategy, Interp1DStrategyBuilder, Linear};
+pub use strategies::linear::Linear;
+pub use strategies::{Interp1DStrategy, Interp1DStrategyBuilder};
+
+pub mod cubic_spline {
+    pub use super::strategies::cubic_spline::{
+        BoundaryCondition, CubicSpline, RowBoundary, SingleBoundary,
+    };
+}
 
 /// One dimensional interpolator
 #[derive(Debug)]
@@ -444,7 +451,7 @@ where
         let Interp1DBuilder { x, data, strategy } = self;
 
         if data.ndim() < 1 {
-            return Err(DimensionError(
+            return Err(ShapeError(
                 "data dimension is 0, needs to be at least 1".into(),
             ));
         }
@@ -460,7 +467,7 @@ where
             ));
         }
         if x.len() != data.shape()[0] {
-            return Err(BuilderError::AxisLenght(format!(
+            return Err(BuilderError::ShapeError(format!(
                 "Lengths of x and data axis need to match. Got x: {:}, data: {:}",
                 x.len(),
                 data.shape()[0],

src/interp1d/strategies.rs

@@ -6,11 +6,8 @@ use num_traits::Num;
 use super::Interp1D;
 use crate::{BuilderError, InterpolateError};
 
-mod cubic_spline;
-mod linear;
-
-pub use cubic_spline::CubicSpline;
-pub use linear::Linear;
+pub mod cubic_spline;
+pub mod linear;
 
 pub trait Interp1DStrategyBuilder<Sd, Sx, D>
 where