Add compatibility support for supports_opt_cache_interface

ChrisRackauckas · claude · ChrisRackauckas · commit 18f7a6ba6142 · 2025-09-15T07:13:05.000-04:00
This change updates all uses of supports_opt_cache_interface to check for availability in both SciMLBase and OptimizationBase packages, ensuring compatibility regardless of which package defines the function. Changes made: - Updated all optimization algorithm packages to use isdefined checks - Applied to both simple single-line and complex macro-generated definitions - Covers 20+ files across the entire optimization ecosystem This addresses compatibility issues where supports_opt_cache_interface might be defined in either SciMLBase or OptimizationBase depending on version combinations. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/lib/OptimizationBBO/src/OptimizationBBO.jl b/lib/OptimizationBBO/src/OptimizationBBO.jl
@@ -9,7 +9,11 @@ abstract type BBO end
 
 SciMLBase.requiresbounds(::BBO) = true
 SciMLBase.allowsbounds(::BBO) = true
-SciMLBase.supports_opt_cache_interface(opt::BBO) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::BBO) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::BBO) = true
+end
 
 for j in string.(BlackBoxOptim.SingleObjectiveMethodNames)
     eval(Meta.parse("Base.@kwdef struct BBO_" * j * " <: BBO method=:" * j * " end"))
diff --git a/lib/OptimizationCMAEvolutionStrategy/src/OptimizationCMAEvolutionStrategy.jl b/lib/OptimizationCMAEvolutionStrategy/src/OptimizationCMAEvolutionStrategy.jl
@@ -9,7 +9,11 @@ export CMAEvolutionStrategyOpt
 struct CMAEvolutionStrategyOpt end
 
 SciMLBase.allowsbounds(::CMAEvolutionStrategyOpt) = true
-SciMLBase.supports_opt_cache_interface(opt::CMAEvolutionStrategyOpt) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::CMAEvolutionStrategyOpt) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::CMAEvolutionStrategyOpt) = true
+end
 SciMLBase.requiresgradient(::CMAEvolutionStrategyOpt) = false
 SciMLBase.requireshessian(::CMAEvolutionStrategyOpt) = false
 SciMLBase.requiresconsjac(::CMAEvolutionStrategyOpt) = false
diff --git a/lib/OptimizationEvolutionary/src/OptimizationEvolutionary.jl b/lib/OptimizationEvolutionary/src/OptimizationEvolutionary.jl
@@ -6,7 +6,11 @@ using Optimization.SciMLBase
 
 SciMLBase.allowsbounds(opt::Evolutionary.AbstractOptimizer) = true
 SciMLBase.allowsconstraints(opt::Evolutionary.AbstractOptimizer) = true
-SciMLBase.supports_opt_cache_interface(opt::Evolutionary.AbstractOptimizer) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::Evolutionary.AbstractOptimizer) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::Evolutionary.AbstractOptimizer) = true
+end
 SciMLBase.requiresgradient(opt::Evolutionary.AbstractOptimizer) = false
 SciMLBase.requiresgradient(opt::Evolutionary.NSGA2) = false
 SciMLBase.requireshessian(opt::Evolutionary.AbstractOptimizer) = false
diff --git a/lib/OptimizationGCMAES/src/OptimizationGCMAES.jl b/lib/OptimizationGCMAES/src/OptimizationGCMAES.jl
@@ -11,7 +11,11 @@ struct GCMAESOpt end
 SciMLBase.requiresbounds(::GCMAESOpt) = true
 SciMLBase.allowsbounds(::GCMAESOpt) = true
 SciMLBase.allowscallback(::GCMAESOpt) = false
-SciMLBase.supports_opt_cache_interface(opt::GCMAESOpt) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::GCMAESOpt) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::GCMAESOpt) = true
+end
 SciMLBase.requiresgradient(::GCMAESOpt) = true
 SciMLBase.requireshessian(::GCMAESOpt) = false
 SciMLBase.requiresconsjac(::GCMAESOpt) = false
diff --git a/lib/OptimizationIpopt/src/OptimizationIpopt.jl b/lib/OptimizationIpopt/src/OptimizationIpopt.jl
@@ -13,8 +13,14 @@ const DenseOrSparse{T} = Union{Matrix{T}, SparseMatrixCSC{T}}
 
 struct IpoptOptimizer end
 
-function SciMLBase.supports_opt_cache_interface(alg::IpoptOptimizer)
-    true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    function SciMLBase.supports_opt_cache_interface(alg::IpoptOptimizer)
+        true
+    end
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    function OptimizationBase.supports_opt_cache_interface(alg::IpoptOptimizer)
+        true
+    end
 end
 
 function SciMLBase.requiresgradient(opt::IpoptOptimizer)
diff --git a/lib/OptimizationMOI/src/OptimizationMOI.jl b/lib/OptimizationMOI/src/OptimizationMOI.jl
@@ -283,9 +283,16 @@ end
 include("nlp.jl")
 include("moi.jl")
 
-function SciMLBase.supports_opt_cache_interface(alg::Union{MOI.AbstractOptimizer,
-        MOI.OptimizerWithAttributes})
-    true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    function SciMLBase.supports_opt_cache_interface(alg::Union{MOI.AbstractOptimizer,
+            MOI.OptimizerWithAttributes})
+        true
+    end
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    function OptimizationBase.supports_opt_cache_interface(alg::Union{MOI.AbstractOptimizer,
+            MOI.OptimizerWithAttributes})
+        true
+    end
 end
 
 function SciMLBase.__init(prob::OptimizationProblem,
diff --git a/lib/OptimizationManopt/src/OptimizationManopt.jl b/lib/OptimizationManopt/src/OptimizationManopt.jl
@@ -12,7 +12,11 @@ internal state.
 """
 abstract type AbstractManoptOptimizer end
 
-SciMLBase.supports_opt_cache_interface(opt::AbstractManoptOptimizer) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::AbstractManoptOptimizer) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::AbstractManoptOptimizer) = true
+end
 
 function __map_optimizer_args!(cache::OptimizationCache,
         opt::AbstractManoptOptimizer;
diff --git a/lib/OptimizationMetaheuristics/src/OptimizationMetaheuristics.jl b/lib/OptimizationMetaheuristics/src/OptimizationMetaheuristics.jl
@@ -7,7 +7,11 @@ using Optimization.SciMLBase
 SciMLBase.requiresbounds(opt::Metaheuristics.AbstractAlgorithm) = true
 SciMLBase.allowsbounds(opt::Metaheuristics.AbstractAlgorithm) = true
 SciMLBase.allowscallback(opt::Metaheuristics.AbstractAlgorithm) = false
-SciMLBase.supports_opt_cache_interface(opt::Metaheuristics.AbstractAlgorithm) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::Metaheuristics.AbstractAlgorithm) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::Metaheuristics.AbstractAlgorithm) = true
+end
 
 function initial_population!(opt, cache, bounds, f)
     opt_init = deepcopy(opt)
diff --git a/lib/OptimizationMultistartOptimization/src/OptimizationMultistartOptimization.jl b/lib/OptimizationMultistartOptimization/src/OptimizationMultistartOptimization.jl
@@ -7,7 +7,11 @@ using Optimization.SciMLBase
 SciMLBase.requiresbounds(opt::MultistartOptimization.TikTak) = true
 SciMLBase.allowsbounds(opt::MultistartOptimization.TikTak) = true
 SciMLBase.allowscallback(opt::MultistartOptimization.TikTak) = false
-SciMLBase.supports_opt_cache_interface(opt::MultistartOptimization.TikTak) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::MultistartOptimization.TikTak) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::MultistartOptimization.TikTak) = true
+end
 
 function SciMLBase.__init(prob::SciMLBase.OptimizationProblem,
         opt::MultistartOptimization.TikTak,
diff --git a/lib/OptimizationNLopt/src/OptimizationNLopt.jl b/lib/OptimizationNLopt/src/OptimizationNLopt.jl
@@ -8,7 +8,11 @@ using Optimization: deduce_retcode
 (f::NLopt.Algorithm)() = f
 
 SciMLBase.allowsbounds(opt::Union{NLopt.Algorithm, NLopt.Opt}) = true
-SciMLBase.supports_opt_cache_interface(opt::Union{NLopt.Algorithm, NLopt.Opt}) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::Union{NLopt.Algorithm, NLopt.Opt}) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::Union{NLopt.Algorithm, NLopt.Opt}) = true
+end
 
 function SciMLBase.requiresgradient(opt::Union{NLopt.Algorithm, NLopt.Opt})
     # https://github.com/JuliaOpt/NLopt.jl/blob/master/src/NLopt.jl#L18C7-L18C16
diff --git a/lib/OptimizationODE/src/OptimizationODE.jl b/lib/OptimizationODE/src/OptimizationODE.jl
@@ -21,7 +21,11 @@ HighOrderDescent() = ODEOptimizer(Vern7())
 SciMLBase.requiresbounds(::ODEOptimizer) = false
 SciMLBase.allowsbounds(::ODEOptimizer) = false
 SciMLBase.allowscallback(::ODEOptimizer) = true
-SciMLBase.supports_opt_cache_interface(::ODEOptimizer) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(::ODEOptimizer) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(::ODEOptimizer) = true
+end
 SciMLBase.requiresgradient(::ODEOptimizer) = true
 SciMLBase.requireshessian(::ODEOptimizer) = false
 SciMLBase.requiresconsjac(::ODEOptimizer) = false
diff --git a/lib/OptimizationOptimJL/src/OptimizationOptimJL.jl b/lib/OptimizationOptimJL/src/OptimizationOptimJL.jl
@@ -11,9 +11,15 @@ SciMLBase.allowsbounds(opt::Optim.AbstractOptimizer) = true
 SciMLBase.allowsbounds(opt::Optim.SimulatedAnnealing) = false
 SciMLBase.requiresbounds(opt::Optim.Fminbox) = true
 SciMLBase.requiresbounds(opt::Optim.SAMIN) = true
-SciMLBase.supports_opt_cache_interface(opt::Optim.AbstractOptimizer) = true
-SciMLBase.supports_opt_cache_interface(opt::Union{Optim.Fminbox, Optim.SAMIN}) = true
-SciMLBase.supports_opt_cache_interface(opt::Optim.ConstrainedOptimizer) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::Optim.AbstractOptimizer) = true
+    SciMLBase.supports_opt_cache_interface(opt::Union{Optim.Fminbox, Optim.SAMIN}) = true
+    SciMLBase.supports_opt_cache_interface(opt::Optim.ConstrainedOptimizer) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::Optim.AbstractOptimizer) = true
+    OptimizationBase.supports_opt_cache_interface(opt::Union{Optim.Fminbox, Optim.SAMIN}) = true
+    OptimizationBase.supports_opt_cache_interface(opt::Optim.ConstrainedOptimizer) = true
+end
 function SciMLBase.requiresgradient(opt::Optim.AbstractOptimizer)
     !(opt isa Optim.ZerothOrderOptimizer)
 end
diff --git a/lib/OptimizationOptimisers/src/OptimizationOptimisers.jl b/lib/OptimizationOptimisers/src/OptimizationOptimisers.jl
@@ -4,7 +4,11 @@ using Reexport, Printf, ProgressLogging
 @reexport using Optimisers, Optimization
 using Optimization.SciMLBase, Optimization.OptimizationBase
 
-SciMLBase.supports_opt_cache_interface(opt::AbstractRule) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::AbstractRule) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::AbstractRule) = true
+end
 SciMLBase.requiresgradient(opt::AbstractRule) = true
 SciMLBase.allowsfg(opt::AbstractRule) = true
 
diff --git a/lib/OptimizationPRIMA/src/OptimizationPRIMA.jl b/lib/OptimizationPRIMA/src/OptimizationPRIMA.jl
@@ -11,7 +11,11 @@ struct BOBYQA <: PRIMASolvers end
 struct LINCOA <: PRIMASolvers end
 struct COBYLA <: PRIMASolvers end
 
-SciMLBase.supports_opt_cache_interface(::PRIMASolvers) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(::PRIMASolvers) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(::PRIMASolvers) = true
+end
 SciMLBase.allowsconstraints(::Union{LINCOA, COBYLA}) = true
 SciMLBase.allowsbounds(opt::Union{BOBYQA, LINCOA, COBYLA}) = true
 SciMLBase.requiresconstraints(opt::COBYLA) = true
diff --git a/lib/OptimizationPyCMA/src/OptimizationPyCMA.jl b/lib/OptimizationPyCMA/src/OptimizationPyCMA.jl
@@ -19,7 +19,11 @@ end
 
 # Defining the SciMLBase interface for PyCMAOpt
 SciMLBase.allowsbounds(::PyCMAOpt) = true
-SciMLBase.supports_opt_cache_interface(opt::PyCMAOpt) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::PyCMAOpt) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::PyCMAOpt) = true
+end
 SciMLBase.allowscallback(::PyCMAOpt) = true
 SciMLBase.requiresgradient(::PyCMAOpt) = false
 SciMLBase.requireshessian(::PyCMAOpt) = false
diff --git a/lib/OptimizationSciPy/src/OptimizationSciPy.jl b/lib/OptimizationSciPy/src/OptimizationSciPy.jl
@@ -216,17 +216,29 @@ for opt_type in [:ScipyMinimize, :ScipyDifferentialEvolution, :ScipyBasinhopping
     :ScipyLinprog, :ScipyMilp]
     @eval begin
         SciMLBase.allowsbounds(::$opt_type) = true
-        SciMLBase.supports_opt_cache_interface(::$opt_type) = true
+        if isdefined(SciMLBase, :supports_opt_cache_interface)
+            SciMLBase.supports_opt_cache_interface(::$opt_type) = true
+        elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+            OptimizationBase.supports_opt_cache_interface(::$opt_type) = true
+        end
     end
 end
 
 for opt_type in [:ScipyMinimizeScalar, :ScipyRootScalar, :ScipyLeastSquares]
     @eval begin
-        SciMLBase.supports_opt_cache_interface(::$opt_type) = true
+        if isdefined(SciMLBase, :supports_opt_cache_interface)
+            SciMLBase.supports_opt_cache_interface(::$opt_type) = true
+        elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+            OptimizationBase.supports_opt_cache_interface(::$opt_type) = true
+        end
     end
 end
 
-SciMLBase.supports_opt_cache_interface(::ScipyRoot) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(::ScipyRoot) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(::ScipyRoot) = true
+end
 
 function SciMLBase.requiresgradient(opt::ScipyMinimize)
     gradient_free = ["Nelder-Mead", "Powell", "COBYLA", "COBYQA"]
diff --git a/lib/OptimizationSpeedMapping/src/OptimizationSpeedMapping.jl b/lib/OptimizationSpeedMapping/src/OptimizationSpeedMapping.jl
@@ -10,7 +10,11 @@ struct SpeedMappingOpt end
 
 SciMLBase.allowsbounds(::SpeedMappingOpt) = true
 SciMLBase.allowscallback(::SpeedMappingOpt) = false
-SciMLBase.supports_opt_cache_interface(opt::SpeedMappingOpt) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::SpeedMappingOpt) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::SpeedMappingOpt) = true
+end
 SciMLBase.requiresgradient(opt::SpeedMappingOpt) = true
 
 function __map_optimizer_args(cache::OptimizationCache, opt::SpeedMappingOpt;
diff --git a/src/auglag.jl b/src/auglag.jl
@@ -9,7 +9,11 @@
     ϵ = 1e-8
 end
 
-SciMLBase.supports_opt_cache_interface(::AugLag) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(::AugLag) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(::AugLag) = true
+end
 SciMLBase.allowsbounds(::AugLag) = true
 SciMLBase.requiresgradient(::AugLag) = true
 SciMLBase.allowsconstraints(::AugLag) = true
diff --git a/src/lbfgsb.jl b/src/lbfgsb.jl
@@ -23,7 +23,11 @@ References
     ϵ = 1e-8
 end
 
-SciMLBase.supports_opt_cache_interface(::LBFGS) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(::LBFGS) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(::LBFGS) = true
+end
 SciMLBase.allowsbounds(::LBFGS) = true
 SciMLBase.requiresgradient(::LBFGS) = true
 SciMLBase.allowsconstraints(::LBFGS) = true
diff --git a/src/sophia.jl b/src/sophia.jl
@@ -53,7 +53,11 @@ struct Sophia
     ρ::Float64
 end
 
-SciMLBase.supports_opt_cache_interface(opt::Sophia) = true
+if isdefined(SciMLBase, :supports_opt_cache_interface)
+    SciMLBase.supports_opt_cache_interface(opt::Sophia) = true
+elseif isdefined(OptimizationBase, :supports_opt_cache_interface)
+    OptimizationBase.supports_opt_cache_interface(opt::Sophia) = true
+end
 SciMLBase.requiresgradient(opt::Sophia) = true
 SciMLBase.allowsfg(opt::Sophia) = true
 SciMLBase.requireshessian(opt::Sophia) = true
