fix: drop Optim <1; add NLSolversBase compat + Optim v1 CI

Author: MilesCranmerBot

.github/workflows/CI.yml

@@ -99,6 +99,24 @@ jobs:
           path: lcov.info
 
 
+  optim_v1_smoketest:
+    name: Optim v1 (NLSolversBase v7) - ubuntu-latest
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - name: Pin Optim v1 and run tests
+        run: |
+          julia --color=yes -e 'import Pkg; Pkg.activate("test"); Pkg.add(Pkg.PackageSpec(name="Optim", version="1")); Pkg.status(["Optim", "NLSolversBase"])'
+          julia --color=yes --threads=auto --check-bounds=yes --depwarn=yes -e 'import Pkg; Pkg.activate("."); Pkg.test()'
+        shell: bash
+
+
   codecov:
     name: Upload combined coverage to Codecov
     runs-on: ubuntu-latest

Project.toml

@@ -18,13 +18,14 @@ TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 Bumper = "8ce10254-0962-460f-a3d8-1f77fea1446e"
 LoopVectorization = "bdcacae8-1622-11e9-2a5c-532679323890"
 Optim = "429524aa-4258-5aef-a3af-852621145aeb"
+NLSolversBase = "d41bc354-129a-5804-8e4c-c37616107c6c"
 SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 
 [extensions]
 DynamicExpressionsBumperExt = "Bumper"
 DynamicExpressionsLoopVectorizationExt = "LoopVectorization"
-DynamicExpressionsOptimExt = "Optim"
+DynamicExpressionsOptimExt = ["Optim", "NLSolversBase"]
 DynamicExpressionsSymbolicUtilsExt = "SymbolicUtils"
 DynamicExpressionsZygoteExt = "Zygote"
 
@@ -36,7 +37,8 @@ DispatchDoctor = "0.4"
 Interfaces = "0.3"
 LoopVectorization = "0.12"
 MacroTools = "0.4, 0.5"
-Optim = "0.19, 1, 2"
+Optim = "1, 2"
+NLSolversBase = "7, 8"
 PrecompileTools = "1"
 Reexport = "1"
 SymbolicUtils = "0.19, ^1.0.5, 2, 3"
@@ -49,5 +51,6 @@ TOML = "1"
 Bumper = "8ce10254-0962-460f-a3d8-1f77fea1446e"
 LoopVectorization = "bdcacae8-1622-11e9-2a5c-532679323890"
 Optim = "429524aa-4258-5aef-a3af-852621145aeb"
+NLSolversBase = "d41bc354-129a-5804-8e4c-c37616107c6c"
 SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"

ext/DynamicExpressionsOptimExt.jl

@@ -9,7 +9,8 @@ using DynamicExpressions:
     set_scalar_constants!,
     get_number_type
 
-import Optim: Optim, OptimizationResults, NLSolversBase
+import Optim: Optim, OptimizationResults
+import NLSolversBase
 
 #! format: off
 """
@@ -90,16 +91,20 @@ function wrap_func(
     return nothing
 end
 
+# `NLSolversBase.InplaceObjective` is an internal type whose field layout changed
+# between NLSolversBase versions.
+#
+# - NLSolversBase v7 (Optim v1.x):  df, fdf, fgh, hv, fghv
+# - NLSolversBase v8 (Optim v2.x):  fdf, fgh, hvp, fghvp, fjvp
 const _INPLACEOBJECTIVE_SPEC_V8 = (
     fields=(:fdf, :fgh, :hvp, :fghvp, :fjvp),
     x_last=(:fdf, :fgh),
     xv_tail=(:hvp, :fghvp, :fjvp),
 )
 const _INPLACEOBJECTIVE_SPEC_V7 = (
-    fields=(:df, :fdf, :fgh, :hv, :fghv), x_last=(:df, :fdf, :fgh), xv_tail=(:hv, :fghv)
-)
-const _INPLACEOBJECTIVE_SPEC_OLD = (
-    fields=(:fdf, :fgh, :hv, :fghv), x_last=(:fdf, :fgh), xv_tail=(:hv, :fghv)
+    fields=(:df, :fdf, :fgh, :hv, :fghv),
+    x_last=(:df, :fdf, :fgh),
+    xv_tail=(:hv, :fghv),
 )
 
 @inline function _wrap_inplaceobjective_field(
@@ -144,15 +149,13 @@ function wrap_func(
     elseif fieldnames(NLSolversBase.InplaceObjective) == _INPLACEOBJECTIVE_SPEC_V7.fields
         # NLSolversBase v7 / Optim v1
         return _wrap_inplaceobjective(f, tree, refs, _INPLACEOBJECTIVE_SPEC_V7)
-    elseif fieldnames(NLSolversBase.InplaceObjective) == _INPLACEOBJECTIVE_SPEC_OLD.fields
-        # Older NLSolversBase / Optim
-        return _wrap_inplaceobjective(f, tree, refs, _INPLACEOBJECTIVE_SPEC_OLD)
+    # (Optim < 1 is no longer supported.)
     else
         fields = fieldnames(NLSolversBase.InplaceObjective)
         throw(
             ArgumentError(
                 "Unsupported NLSolversBase.InplaceObjective field layout: $(fields). " *
-                "This extension supports layouts used by Optim v1 and v2. " *
+                "This extension supports layouts used by NLSolversBase v7 (Optim v1) and v8 (Optim v2). " *
                 "Please open an issue at github.com/SymbolicML/DynamicExpressions.jl with your versions.",
             ),
         )