doc

jonasBoss · Feb 9, 2024 · 1704d32 · 1704d32
1 parent ffcfd65
commit 1704d32
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
    - 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`

diff --git a/Cargo.toml b/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"
@@ -13,7 +13,7 @@ categories = ["science", "algorithms", "mathematics"]
 
 [dependencies]
 ndarray = "0.15"
-num-traits = {version = "0.2"}
+num-traits = "0.2"
 thiserror = "1.0"
 
 [dev-dependencies]

diff --git a/src/interp1d/strategies/cubic_spline.rs b/src/interp1d/strategies/cubic_spline.rs
@@ -15,6 +15,9 @@ use super::{Interp1DStrategy, Interp1DStrategyBuilder};
 
 const AX0: Axis = Axis(0);
 
+/// Marker trait that is implemented for anithing that satisfies
+/// the trait bounds required to be used as an element in the QubicSpline
+/// strategy.
 pub trait SplineNum:
     Debug
     + Num