change api: use Option for smooth and spline instead of expect panic

Author: espdev

src/umv.rs

@@ -281,24 +281,14 @@ impl<'a, T, D> CubicSmoothingSpline<'a, T, D>
         Ok(yi)
     }
 
-    /// Returns the smoothing parameter
-    ///
-    /// # Panics
-    ///
-    /// - If the smoothing parameter has not been set or computed
-    ///
-    pub fn smooth(&self) -> T {
-        self.smooth.expect("The smoothing parameter yet has not been set or computed.")
+    /// Returns the smoothing parameter or None
+    pub fn smooth(&self) -> Option<T> {
+        self.smooth
     }
 
-    /// Returns `NdSpline` struct with data of computed spline
-    ///
-    /// # Panics
-    ///
-    /// - If the spline has not been computed
-    ///
-    pub fn spline(&self) -> &NdSpline<'a, T> {
-        self.spline.as_ref().expect("The spline yet has not been computed.")
+    /// Returns the ref to `NdSpline` struct with data of computed spline or None
+    pub fn spline(&self) -> Option<&NdSpline<'a, T>> {
+        self.spline.as_ref()
     }
 
     /// Invalidate computed spline

tests/umv_full.rs

@@ -16,7 +16,7 @@ fn test_without_weights_auto_smooth_1() {
         .make()
         .unwrap();
 
-    assert_abs_diff_eq!(s.smooth(), 0.8999999999999999);
+    assert_abs_diff_eq!(s.smooth().unwrap(), 0.8999999999999999);
 
     let coeffs_expected = array![[
         -0.41780962939499505,  0.39429046563192893,
@@ -30,7 +30,7 @@ fn test_without_weights_auto_smooth_1() {
 
      ]];
 
-    assert_abs_diff_eq!(s.spline().coeffs(), coeffs_expected, epsilon = EPS);
+    assert_abs_diff_eq!(s.spline().unwrap().coeffs(), coeffs_expected, epsilon = EPS);
 
     let ys = s.evaluate(&x).unwrap();
 
@@ -70,7 +70,7 @@ fn test_without_weights_auto_smooth_2() {
          2.87797144570959,        6.6215506411899465,
     ]).insert_axis(Axis(0));
 
-    assert_abs_diff_eq!(s.spline().coeffs(), coeffs_expected, epsilon = EPS);
+    assert_abs_diff_eq!(s.spline().unwrap().coeffs(), coeffs_expected, epsilon = EPS);
 
     let ys = s.evaluate(&x).unwrap();
 
@@ -103,7 +103,7 @@ fn test_with_weights_and_smooth() {
          1.7816259351620949,  2.3935461346633415,   2.247780548628429,     2.226284289276808
      ]];
 
-    assert_abs_diff_eq!(s.spline().coeffs(), coeffs_expected, epsilon = EPS);
+    assert_abs_diff_eq!(s.spline().unwrap().coeffs(), coeffs_expected, epsilon = EPS);
 
     let ys = s.evaluate(&x).unwrap();
 

tests/umv_make.rs

@@ -11,7 +11,7 @@ fn test_driver_make_nd_npt<T, D>(x: Array1<T>, y: Array<T, D>,
         .make()
         .unwrap();
 
-    let spline = s.spline();
+    let spline = s.spline().unwrap();
 
     assert_eq!(spline.order(), order);
     assert_eq!(spline.pieces(), pieces);

tests/umv_validate.rs

@@ -13,6 +13,7 @@ fn test_sites_invalid_order_1() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "Data site values must satisfy the condition: x1 < x2 < ... < xN")]
 fn test_sites_invalid_order_2() {
@@ -24,6 +25,7 @@ fn test_sites_invalid_order_2() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "`y` has zero dimensionality")]
 fn test_zero_ndim_y_error() {
@@ -35,6 +37,7 @@ fn test_zero_ndim_y_error() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "The shape[0] (5) of `y` data is not equal to `x` size (4)")]
 fn test_data_size_mismatch_error() {
@@ -46,6 +49,7 @@ fn test_data_size_mismatch_error() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "`axis` value (1) is out of bounds `y` dimensionality (1)")]
 fn test_axis_out_of_bounds_error() {
@@ -58,6 +62,7 @@ fn test_axis_out_of_bounds_error() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "`weights` size (5) is not equal to `x` size (4)")]
 fn test_weights_size_mismatch_error() {
@@ -71,6 +76,7 @@ fn test_weights_size_mismatch_error() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "`smooth` value must be in range 0..1, given -0.5")]
 fn test_smooth_less_than_error() {
@@ -84,6 +90,7 @@ fn test_smooth_less_than_error() {
         .unwrap();
 }
 
+
 #[test]
 #[should_panic(expected = "`smooth` value must be in range 0..1, given 1.5")]
 fn test_smooth_greater_than_error() {
@@ -97,17 +104,6 @@ fn test_smooth_greater_than_error() {
         .unwrap();
 }
 
-#[test]
-#[should_panic(expected = "The size of `xi` must be greater or equal to 2")]
-fn test_evaluate_invalid_xi_error() {
-    let x = array![1., 2., 3., 4.];
-    let y = array![1., 2., 3., 4.];
-    let xi = array![1.];
-
-    let spline = CubicSmoothingSpline::new(&x, &y);
-
-    spline.evaluate(&xi).unwrap();
-}
 
 #[test]
 #[should_panic(expected = "The spline has not been computed, use `make` method before")]