refactor: change asserts to errors in tableau checks (#180)

* refactor: change asserts to errors in tableau checks

* collapse if statement

Author: martinjrobins

diffsol/src/error.rs

@@ -100,6 +100,8 @@ pub enum OdeSolverError {
     ProblemNotSet,
     #[error("Jacobian not available")]
     JacobianNotAvailable,
+    #[error("Invalid Tableau: {0}")]
+    InvalidTableau(String),
     #[error("Error: {0}")]
     Other(String),
 }

diffsol/src/ode_solver/runge_kutta.rs

@@ -225,36 +225,45 @@ where
         let s = tableau.s();
         for i in 0..s {
             for j in i..s {
-                assert_eq!(
-                    tableau.a().get_index(i, j),
-                    Eqn::T::zero(),
-                    "Invalid tableau, expected a(i, j) = 0 for i >= j"
-                );
+                if tableau.a().get_index(i, j) != Eqn::T::zero() {
+                    return Err(ode_solver_error!(
+                        InvalidTableau,
+                        format!(
+                            "Invalid tableau, expected a(i, j) = 0 for i >= j, but found a({}, {}) = {}",
+                            i,
+                            j,
+                            tableau.a().get_index(i, j)
+                        )
+                    ));
+                }
             }
         }
 
         // check last row of a is the same as b
         for i in 0..s {
-            assert_eq!(
-                tableau.a().get_index(s - 1, i),
-                tableau.b().get_index(i),
-                "Invalid tableau, expected a(s-1, i) = b(i)"
-            );
+            if tableau.a().get_index(s - 1, i) != tableau.b().get_index(i) {
+                return Err(ode_solver_error!(
+                    InvalidTableau,
+                    "Invalid tableau, expected a(s-1, i) = b(i)"
+                ));
+            }
         }
 
         // check that last c is 1
-        assert_eq!(
-            tableau.c().get_index(s - 1),
-            Eqn::T::one(),
-            "Invalid tableau, expected c(s-1) = 1"
-        );
+        if tableau.c().get_index(s - 1) != Eqn::T::one() {
+            return Err(ode_solver_error!(
+                InvalidTableau,
+                "Invalid tableau, expected c(s-1) = 1"
+            ));
+        }
 
         // check that first c is 0
-        assert_eq!(
-            tableau.c().get_index(0),
-            Eqn::T::zero(),
-            "Invalid tableau, expected c(0) = 0"
-        );
+        if tableau.c().get_index(0) != Eqn::T::zero() {
+            return Err(ode_solver_error!(
+                InvalidTableau,
+                "Invalid tableau, expected c(0) = 0"
+            ));
+        }
         Ok(())
     }
 
@@ -267,54 +276,60 @@ where
         let s = tableau.s();
         for i in 0..s {
             for j in (i + 1)..s {
-                assert_eq!(
-                    tableau.a().get_index(i, j),
-                    Eqn::T::zero(),
-                    "Invalid tableau, expected a(i, j) = 0 for i > j"
-                );
+                if tableau.a().get_index(i, j) != Eqn::T::zero() {
+                    return Err(ode_solver_error!(
+                        InvalidTableau,
+                        "Invalid tableau, expected a(i, j) = 0 for i > j"
+                    ));
+                }
             }
         }
         let gamma = tableau.a().get_index(1, 1);
         //check that for i = 1..s-1, a(i, i) = gamma
         for i in 1..tableau.s() {
-            assert_eq!(
-                tableau.a().get_index(i, i),
-                gamma,
-                "Invalid tableau, expected a(i, i) = gamma = {gamma} for i = 1..s-1",
-            );
+            if tableau.a().get_index(i, i) != gamma {
+                return Err(ode_solver_error!(
+                    InvalidTableau,
+                    format!("Invalid tableau, expected a(i, i) = gamma = {gamma} for i = 1..s-1")
+                ));
+            }
         }
         // if a(0, 0) = gamma, then we're a SDIRK method
         // if a(0, 0) = 0, then we're a ESDIRK method
         // otherwise, error
         let zero = Eqn::T::zero();
         if tableau.a().get_index(0, 0) != zero && tableau.a().get_index(0, 0) != gamma {
-            panic!("Invalid tableau, expected a(0, 0) = 0 or a(0, 0) = gamma");
+            return Err(ode_solver_error!(
+                InvalidTableau,
+                "Invalid tableau, expected a(0, 0) = 0 or a(0, 0) = gamma"
+            ));
         }
         let is_sdirk = tableau.a().get_index(0, 0) == gamma;
 
         // check last row of a is the same as b
         for i in 0..s {
-            assert_eq!(
-                tableau.a().get_index(s - 1, i),
-                tableau.b().get_index(i),
-                "Invalid tableau, expected a(s-1, i) = b(i)"
-            );
+            if tableau.a().get_index(s - 1, i) != tableau.b().get_index(i) {
+                return Err(ode_solver_error!(
+                    InvalidTableau,
+                    "Invalid tableau, expected a(s-1, i) = b(i)"
+                ));
+            }
         }
 
         // check that last c is 1
-        assert_eq!(
-            tableau.c().get_index(s - 1),
-            Eqn::T::one(),
-            "Invalid tableau, expected c(s-1) = 1"
-        );
+        if tableau.c().get_index(s - 1) != Eqn::T::one() {
+            return Err(ode_solver_error!(
+                InvalidTableau,
+                "Invalid tableau, expected c(s-1) = 1"
+            ));
+        }
 
         // check that the first c is 0 for esdirk methods
-        if !is_sdirk {
-            assert_eq!(
-                tableau.c().get_index(0),
-                Eqn::T::zero(),
+        if !is_sdirk && tableau.c().get_index(0) != Eqn::T::zero() {
+            return Err(ode_solver_error!(
+                InvalidTableau,
                 "Invalid tableau, expected c(0) = 0 for esdirk methods"
-            );
+            ));
         }
         Ok(())
     }