refactor!: rename SolveError to TestingError

datamole-ai · Nov 12, 2023 · 7e72ec7 · 7e72ec7
1 parent 9ea04f0
commit 7e72ec7
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/src/solver/nelder_mead.rs b/src/solver/nelder_mead.rs
@@ -629,7 +629,7 @@ mod tests {
         // outside the bounds.
         assert!(matches!(
             solve(&f, &dom, solver, x, 5, eps),
-            Err(SolveError::Solver(NelderMeadError::SimplexCollapsed))
+            Err(TestingError::Inner(NelderMeadError::SimplexCollapsed))
         ));
     }
 

diff --git a/src/solver/trust_region.rs b/src/solver/trust_region.rs
@@ -1115,7 +1115,7 @@ mod tests {
         // the bounds.
         assert!(matches!(
             solve(&f, &dom, solver, x, 50, eps),
-            Err(SolveError::Solver(TrustRegionError::NoProgress)) | Err(SolveError::Termination)
+            Err(TestingError::Inner(TrustRegionError::NoProgress)) | Err(TestingError::Termination)
         ));
     }
 
@@ -1129,7 +1129,7 @@ mod tests {
             let solver = TrustRegion::new(&f, &dom);
             assert!(match solve(&f, &dom, solver, x, 25, eps) {
                 Ok(root) => f.is_root(&root, eps),
-                Err(SolveError::Solver(TrustRegionError::NoValidStep)) => true,
+                Err(TestingError::Inner(TrustRegionError::NoValidStep)) => true,
                 Err(error) => panic!("{:?}", error),
             });
         }

diff --git a/src/testing.rs b/src/testing.rs
@@ -654,12 +654,13 @@ impl TestProblem for InfiniteSolutions {
 
 impl TestSystem for InfiniteSolutions {}
 
-/// Solving error of the testing solver driver (see [`solve`]).
+/// Solving or optimization error of the testing solver/optimizer driver (see
+/// [`solve`] and [`optimize`]).
 #[derive(Debug, Error)]
-pub enum SolveError<E: StdError + 'static> {
+pub enum TestingError<E: StdError + 'static> {
     /// Error of the solver used.
     #[error("{0}")]
-    Solver(#[from] E),
+    Inner(#[from] E),
     /// Solver did not terminate.
     #[error("solver did not terminate")]
     Termination,
@@ -673,7 +674,7 @@ pub fn solve<F: TestSystem, S: Solver<F>>(
     mut x: OVector<F::Scalar, F::Dim>,
     max_iters: usize,
     tolerance: F::Scalar,
-) -> Result<OVector<F::Scalar, F::Dim>, SolveError<S::Error>>
+) -> Result<OVector<F::Scalar, F::Dim>, TestingError<S::Error>>
 where
     DefaultAllocator: Allocator<F::Scalar, F::Dim>,
     S::Error: StdError,
@@ -689,7 +690,7 @@ where
         }
 
         if iter == max_iters {
-            return Err(SolveError::Termination);
+            return Err(TestingError::Termination);
         } else {
             iter += 1;
         }
@@ -705,7 +706,7 @@ pub fn optimize<F: Function, O: Optimizer<F>>(
     min: F::Scalar,
     max_iters: usize,
     tolerance: F::Scalar,
-) -> Result<OVector<F::Scalar, F::Dim>, SolveError<O::Error>>
+) -> Result<OVector<F::Scalar, F::Dim>, TestingError<O::Error>>
 where
     DefaultAllocator: Allocator<F::Scalar, F::Dim>,
     O::Error: StdError,
@@ -721,7 +722,7 @@ where
         }
 
         if iter == max_iters {
-            return Err(SolveError::Termination);
+            return Err(TestingError::Termination);
         } else {
             iter += 1;
         }