feat: bring in changes from SciML/SimpleNonlinearSolve.jl#158

SciML · Oct 5, 2024 · 69e5767 · 69e5767
1 parent d780662
commit 69e5767
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 5 deletions.
diff --git a/lib/BracketingNonlinearSolve/src/bisection.jl b/lib/BracketingNonlinearSolve/src/bisection.jl
@@ -20,7 +20,7 @@ A common bisection method.
 end
 
 function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Bisection,
-        args...; maxiters = 1000, abstol = nothing, kwargs...)
+        args...; maxiters = 1000, abstol = nothing, verbose::Bool = true, kwargs...)
     @assert !SciMLBase.isinplace(prob) "`Bisection` only supports out-of-place problems."
 
     f = Base.Fix2(prob.f, prob.p)
@@ -40,6 +40,14 @@ function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Bisection,
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        verbose &&
+            @warn "The interval is not an enclosing interval, opposite signs at the \
+                   boundaries are required."
+        return SciMLBase.build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     i = 1
     while i ≤ maxiters
         mid = (left + right) / 2

diff --git a/lib/BracketingNonlinearSolve/src/brent.jl b/lib/BracketingNonlinearSolve/src/brent.jl
@@ -6,7 +6,7 @@ Left non-allocating Brent method.
 struct Brent <: AbstractBracketingAlgorithm end
 
 function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Brent, args...;
-        maxiters = 1000, abstol = nothing, kwargs...)
+        maxiters = 1000, abstol = nothing, verbose::Bool = true, kwargs...)
     @assert !SciMLBase.isinplace(prob) "`Brent` only supports out-of-place problems."
 
     f = Base.Fix2(prob.f, prob.p)
@@ -27,6 +27,14 @@ function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Brent, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        verbose &&
+            @warn "The interval is not an enclosing interval, opposite signs at the \
+                   boundaries are required."
+        return SciMLBase.build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     if abs(fl) < abs(fr)
         left, right = right, left
         fl, fr = fr, fl

diff --git a/lib/BracketingNonlinearSolve/src/falsi.jl b/lib/BracketingNonlinearSolve/src/falsi.jl
@@ -6,7 +6,7 @@ A non-allocating regula falsi method.
 struct Falsi <: AbstractBracketingAlgorithm end
 
 function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Falsi, args...;
-        maxiters = 1000, abstol = nothing, kwargs...)
+        maxiters = 1000, abstol = nothing, verbose::Bool = true, kwargs...)
     @assert !SciMLBase.isinplace(prob) "`False` only supports out-of-place problems."
 
     f = Base.Fix2(prob.f, prob.p)
@@ -27,6 +27,14 @@ function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Falsi, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        verbose &&
+            @warn "The interval is not an enclosing interval, opposite signs at the \
+                   boundaries are required."
+        return SciMLBase.build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     i = 1
     while i ≤ maxiters
         if Impl.nextfloat_tdir(left, l, r) == right

diff --git a/lib/BracketingNonlinearSolve/src/itp.jl b/lib/BracketingNonlinearSolve/src/itp.jl
@@ -57,7 +57,7 @@ function ITP(; scaled_k1::Real = 0.2, k2::Real = 2, n0::Int = 10)
 end
 
 function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::ITP, args...;
-        maxiters = 1000, abstol = nothing, kwargs...)
+        maxiters = 1000, abstol = nothing, verbose::Bool = true, kwargs...)
     @assert !SciMLBase.isinplace(prob) "`ITP` only supports out-of-place problems."
 
     f = Base.Fix2(prob.f, prob.p)
@@ -77,6 +77,14 @@ function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::ITP, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        verbose &&
+            @warn "The interval is not an enclosing interval, opposite signs at the \
+                   boundaries are required."
+        return SciMLBase.build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     ϵ = abstol
     k2 = alg.k2
     k1 = alg.scaled_k1 * abs(right - left)^(1 - k2)

diff --git a/lib/BracketingNonlinearSolve/src/ridder.jl b/lib/BracketingNonlinearSolve/src/ridder.jl
@@ -6,7 +6,7 @@ A non-allocating ridder method.
 struct Ridder <: AbstractBracketingAlgorithm end
 
 function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Ridder, args...;
-        maxiters = 1000, abstol = nothing, kwargs...)
+        maxiters = 1000, abstol = nothing, verbose::Bool = true, kwargs...)
     @assert !SciMLBase.isinplace(prob) "`Ridder` only supports out-of-place problems."
 
     f = Base.Fix2(prob.f, prob.p)
@@ -26,6 +26,14 @@ function CommonSolve.solve(prob::IntervalNonlinearProblem, alg::Ridder, args...;
             prob, alg, right, fr; retcode = ReturnCode.ExactSolutionRight, left, right)
     end
 
+    if sign(fl) == sign(fr)
+        verbose &&
+            @warn "The interval is not an enclosing interval, opposite signs at the \
+                   boundaries are required."
+        return SciMLBase.build_solution(
+            prob, alg, left, fl; retcode = ReturnCode.InitialFailure, left, right)
+    end
+
     xo = oftype(left, Inf)
     i = 1
     while i ≤ maxiters