Merge pull request #158 from TomRottier/main

Return InitialFailure from bracketing methods if not enclosing interval
SciML · Sep 24, 2024 · b8239bd · b8239bd
2 parents ae4f888 + 3f416ee
commit b8239bd
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 0 deletions.
diff --git a/src/bracketing/bisection.jl b/src/bracketing/bisection.jl
@@ -39,6 +39,12 @@ function SciMLBase.solve(prob::IntervalNonlinearProblem, alg::Bisection,
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        @warn "The interval is not an enclosing interval, opposite signs at the boundaries are required."
+        return build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     i = 1
     if !iszero(fr)
         while i < maxiters

diff --git a/src/bracketing/brent.jl b/src/bracketing/brent.jl
@@ -26,6 +26,12 @@ function SciMLBase.solve(prob::IntervalNonlinearProblem, alg::Brent, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        @warn "The interval is not an enclosing interval, opposite signs at the boundaries are required."
+        return build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     if abs(fl) < abs(fr)
         c = right
         right = left

diff --git a/src/bracketing/falsi.jl b/src/bracketing/falsi.jl
@@ -25,6 +25,12 @@ function SciMLBase.solve(prob::IntervalNonlinearProblem, alg::Falsi, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        @warn "The interval is not an enclosing interval, opposite signs at the boundaries are required."
+        return build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     # Regula Falsi Steps
     i = 0
     if !iszero(fr)

diff --git a/src/bracketing/itp.jl b/src/bracketing/itp.jl
@@ -75,6 +75,13 @@ function SciMLBase.solve(prob::IntervalNonlinearProblem, alg::ITP, args...;
         return build_solution(
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
+
+    if sign(fl) == sign(fr)
+        @warn "The interval is not an enclosing interval, opposite signs at the boundaries are required."
+        return build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     ϵ = abstol
     #defining variables/cache
     k2 = alg.k2

diff --git a/src/bracketing/ridder.jl b/src/bracketing/ridder.jl
@@ -25,6 +25,12 @@ function SciMLBase.solve(prob::IntervalNonlinearProblem, alg::Ridder, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        @warn "The interval is not an enclosing interval, opposite signs at the boundaries are required."
+        return build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     xo = oftype(left, Inf)
     i = 1
     if !iszero(fr)