change api

Author: espdev

README.md

@@ -31,7 +31,7 @@ fn main() {
 
     let spline = CubicSmoothingSpline::new(&x, &y)
         .with_weights(&w)
-        .with_smooth(0.8)
+        .with_smoothing(0.8)
         .make()
         .unwrap();
 
@@ -55,18 +55,15 @@ fn main() {
     let x1 = array![1.0, 2.0, 3.0, 4.0];
     let x = vec![x0.view(), x1.view()];
 
-    let xi0 = array![1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0];
-    let xi1 = array![1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0];
-    let xi = vec![xi0.view(), xi1.view()];
-    
     let y = array![
-     [0.5, 1.2, 3.4, 2.5],
-     [1.5, 2.2, 4.4, 3.5],
-     [2.5, 3.2, 5.4, 4.5],
-     [3.5, 4.2, 6.4, 5.5],
+        [0.5, 1.2, 3.4, 2.5],
+        [1.5, 2.2, 4.4, 3.5],
+        [2.5, 3.2, 5.4, 4.5],
+        [3.5, 4.2, 6.4, 5.5],
     ];
 
     let yi = GridCubicSmoothingSpline::new(&x, &y)
+     .with_smoothing_fill(0.5)
      .make().unwrap()
      .evaluate(&x).unwrap();
 

src/lib.rs

@@ -62,7 +62,7 @@
 //!
 //! let yi = CubicSmoothingSpline::new(&x, &y)
 //!     .with_weights(&w)
-//!     .with_smooth(0.8)
+//!     .with_smoothing(0.8)
 //!     .make().unwrap()
 //!     .evaluate(&xi).unwrap();
 //!

src/ndg.rs

@@ -215,7 +215,7 @@ impl<'a, T, D> GridCubicSmoothingSpline<'a, T, D>
     ///
     /// If the smoothing parameter value is None, it will be computed automatically.
     ///
-    pub fn with_smooth(mut self, smooth: &[Option<T>]) -> Self {
+    pub fn with_smoothing(mut self, smooth: &[Option<T>]) -> Self {
         self.invalidate();
         self.smooth = smooth.to_vec();
         self
@@ -235,7 +235,7 @@ impl<'a, T, D> GridCubicSmoothingSpline<'a, T, D>
     ///  - 0: The smoothing spline is the least-squares straight line fit to the data
     ///  - 1: The cubic spline interpolant with natural boundary condition
     ///
-    pub fn with_all_smooth(mut self, smooth: T) -> Self {
+    pub fn with_smoothing_fill(mut self, smooth: T) -> Self {
         self.invalidate();
         self.smooth = vec![Some(smooth); self.x.len()];
         self

src/ndg/make.rs

@@ -33,7 +33,7 @@ impl<'a, T, D> GridCubicSmoothingSpline<'a, T, D>
 
             let sp = CubicSmoothingSpline::new(x, y)
                 .with_optional_weights(weights)
-                .with_optional_smooth(s)
+                .with_optional_smoothing(s)
                 .make()?;
 
             smooth[ax] = sp.smooth();

src/umv.rs

@@ -138,7 +138,7 @@ impl<'a, T> NdSpline<'a, T>
 ///
 /// let s = CubicSmoothingSpline::new(&x, &y)
 ///     .with_weights(&w)
-///     .with_smooth(smooth)
+///     .with_smoothing(smooth)
 ///     .make().unwrap();
 ///
 /// let xi = array![1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0];
@@ -263,14 +263,14 @@ impl<'a, T, D> CubicSmoothingSpline<'a, T, D>
     ///  - 0: The smoothing spline is the least-squares straight line fit to the data
     ///  - 1: The cubic spline interpolant with natural boundary condition
     ///
-    pub fn with_smooth(mut self, smooth: T) -> Self {
+    pub fn with_smoothing(mut self, smooth: T) -> Self {
         self.invalidate();
         self.smooth = Some(smooth);
         self
     }
 
     /// Sets the smoothing parameter in `Option` wrap
-    pub fn with_optional_smooth(mut self, smooth: Option<T>) -> Self {
+    pub fn with_optional_smoothing(mut self, smooth: Option<T>) -> Self {
         self.invalidate();
         self.smooth = smooth;
         self

tests/umv_full.rs

@@ -92,7 +92,7 @@ fn test_with_weights_and_smooth() {
 
     let s = CubicSmoothingSpline::new(&x, &y)
         .with_weights(&w)
-        .with_smooth(0.8)
+        .with_smoothing(0.8)
         .make()
         .unwrap();
 

tests/umv_validate.rs

@@ -85,7 +85,7 @@ fn test_smooth_less_than_error() {
     let s = -0.5;
 
     CubicSmoothingSpline::new(&x, &y)
-        .with_smooth(s)
+        .with_smoothing(s)
         .make()
         .unwrap();
 }
@@ -99,7 +99,7 @@ fn test_smooth_greater_than_error() {
     let s = 1.5;
 
     CubicSmoothingSpline::new(&x, &y)
-        .with_smooth(s)
+        .with_smoothing(s)
         .make()
         .unwrap();
 }