Merge pull request #1031 from JuliaSymbolics/preallocationtools

Fix PreallocationTools extension swap

Project.toml

@@ -1,93 +1,94 @@
-name = "Symbolics"
-uuid = "0c5d862f-8b57-4792-8d23-62f2024744c7"
-authors = ["Shashi Gowda <[email protected]>"]
-version = "5.15.0"
-
-[deps]
-ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
-Bijections = "e2ed5e7c-b2de-5872-ae92-c73ca462fb04"
-ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
-DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
-DiffRules = "b552c78f-8df3-52c6-915a-8e097449b14b"
-Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
-DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
-DomainSets = "5b8099bc-c8ec-5219-889f-1d9e522a28bf"
-DynamicPolynomials = "7c1d4256-1411-5781-91ec-d7bc3513ac07"
-Groebner = "0b43b601-686d-58a3-8a1c-6623616c7cd4"
-IfElse = "615f187c-cbe4-4ef1-ba3b-2fcf58d6d173"
-LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
-LambertW = "984bce1d-4616-540c-a9ee-88d1112d94c9"
-Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
-Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
-LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
-LogExpFunctions = "2ab3a3ac-af41-5b50-aa03-7779005ae688"
-MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
-Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
-NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
-PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
-RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
-Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
-Requires = "ae029012-a4dd-5104-9daa-d747884805df"
-RuntimeGeneratedFunctions = "7e49a35a-f44a-4d26-94aa-eba1b4ca6b47"
-SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
-Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
-SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
-SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
-StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
-SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
-SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
-
-[weakdeps]
-PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
-SymPy = "24249f21-da20-56a4-8eb1-6a02cf4ae2e6"
-
-[extensions]
-SymbolicsPreallocationToolsExt = "PreallocationTools"
-SymbolicsSymPyExt = "SymPy"
-
-[compat]
-ArrayInterface = "7"
-Bijections = "0.1"
-ConstructionBase = "1.2"
-DataStructures = "0.18"
-DiffRules = "1.4"
-Distributions = "0.25"
-DocStringExtensions = "0.9"
-DomainSets = "0.6"
-DynamicPolynomials = "0.5"
-Groebner = "0.5"
-IfElse = "0.1"
-LaTeXStrings = "1.3"
-LambertW = "0.4.5"
-Latexify = "0.16"
-LogExpFunctions = "0.3"
-MacroTools = "0.5"
-NaNMath = "1"
-PrecompileTools = "1"
-RecipesBase = "1.1"
-Reexport = "1"
-ReferenceTests = "0.9"
-Requires = "1.1"
-RuntimeGeneratedFunctions = "0.5.9"
-SciMLBase = "2"
-Setfield = "1"
-SpecialFunctions = "2"
-StaticArrays = "1.1"
-SymbolicIndexingInterface = "0.3"
-SymbolicUtils = "1.4"
-julia = "1.10"
-
-[extras]
-BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
-ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
-Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
-PkgBenchmark = "32113eaa-f34f-5b0d-bd6c-c81e245fc73d"
-PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
-SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
-SymPy = "24249f21-da20-56a4-8eb1-6a02cf4ae2e6"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["Test", "SafeTestsets", "Pkg", "PkgBenchmark", "PreallocationTools", "ForwardDiff", "BenchmarkTools", "ReferenceTests", "SymPy", "Random"]
+name = "Symbolics"
+uuid = "0c5d862f-8b57-4792-8d23-62f2024744c7"
+authors = ["Shashi Gowda <[email protected]>"]
+version = "5.15.1"
+
+[deps]
+ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
+Bijections = "e2ed5e7c-b2de-5872-ae92-c73ca462fb04"
+ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
+DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
+DiffRules = "b552c78f-8df3-52c6-915a-8e097449b14b"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+DomainSets = "5b8099bc-c8ec-5219-889f-1d9e522a28bf"
+DynamicPolynomials = "7c1d4256-1411-5781-91ec-d7bc3513ac07"
+Groebner = "0b43b601-686d-58a3-8a1c-6623616c7cd4"
+IfElse = "615f187c-cbe4-4ef1-ba3b-2fcf58d6d173"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
+LambertW = "984bce1d-4616-540c-a9ee-88d1112d94c9"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
+Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+LogExpFunctions = "2ab3a3ac-af41-5b50-aa03-7779005ae688"
+MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
+Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
+NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
+PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
+RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
+Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
+Requires = "ae029012-a4dd-5104-9daa-d747884805df"
+RuntimeGeneratedFunctions = "7e49a35a-f44a-4d26-94aa-eba1b4ca6b47"
+SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
+Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
+SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
+SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
+SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
+
+[weakdeps]
+ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
+PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
+SymPy = "24249f21-da20-56a4-8eb1-6a02cf4ae2e6"
+
+[extensions]
+SymbolicsPreallocationToolsExt = ["ForwardDiff", "PreallocationTools"]
+SymbolicsSymPyExt = "SymPy"
+
+[compat]
+ArrayInterface = "7"
+Bijections = "0.1"
+ConstructionBase = "1.2"
+DataStructures = "0.18"
+DiffRules = "1.4"
+Distributions = "0.25"
+DocStringExtensions = "0.9"
+DomainSets = "0.6"
+DynamicPolynomials = "0.5"
+Groebner = "0.5"
+IfElse = "0.1"
+LaTeXStrings = "1.3"
+LambertW = "0.4.5"
+Latexify = "0.16"
+LogExpFunctions = "0.3"
+MacroTools = "0.5"
+NaNMath = "1"
+PrecompileTools = "1"
+RecipesBase = "1.1"
+Reexport = "1"
+ReferenceTests = "0.9"
+Requires = "1.1"
+RuntimeGeneratedFunctions = "0.5.9"
+SciMLBase = "2"
+Setfield = "1"
+SpecialFunctions = "2"
+StaticArrays = "1.1"
+SymbolicIndexingInterface = "0.3"
+SymbolicUtils = "1.4"
+julia = "1.10"
+
+[extras]
+BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
+ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
+Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+PkgBenchmark = "32113eaa-f34f-5b0d-bd6c-c81e245fc73d"
+PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
+SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
+SymPy = "24249f21-da20-56a4-8eb1-6a02cf4ae2e6"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Test", "SafeTestsets", "Pkg", "PkgBenchmark", "PreallocationTools", "ForwardDiff", "BenchmarkTools", "ReferenceTests", "SymPy", "Random"]

ext/SymbolicsPreallocationToolsExt.jl

@@ -1,49 +1,49 @@
-module PreallocationToolsSymbolicsExt
-
-using PreallocationTools
-import PreallocationTools: _restructure, get_tmp
-using Symbolics, ForwardDiff
-
-function get_tmp(dc::DiffCache, u::Type{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
-    if length(dc.du) > length(dc.any_du)
-        resize!(dc.any_du, length(dc.du))
-    end
-    _restructure(dc.du, dc.any_du)
-end
-
-function get_tmp(dc::DiffCache, u::X) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
-    if length(dc.du) > length(dc.any_du)
-        resize!(dc.any_du, length(dc.du))
-    end
-    _restructure(dc.du, dc.any_du)
-end
-
-function get_tmp(dc::DiffCache, u::AbstractArray{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
-    if length(dc.du) > length(dc.any_du)
-        resize!(dc.any_du, length(dc.du))
-    end
-    _restructure(dc.du, dc.any_du)
-end
-
-function get_tmp(dc::FixedSizeDiffCache, u::Type{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
-    if length(dc.du) > length(dc.any_du)
-        resize!(dc.any_du, length(dc.du))
-    end
-    _restructure(dc.du, dc.any_du)
-end
-
-function get_tmp(dc::FixedSizeDiffCache, u::X) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
-    if length(dc.du) > length(dc.any_du)
-        resize!(dc.any_du, length(dc.du))
-    end
-    _restructure(dc.du, dc.any_du)
-end
-
-function get_tmp(dc::FixedSizeDiffCache, u::AbstractArray{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
-    if length(dc.du) > length(dc.any_du)
-        resize!(dc.any_du, length(dc.du))
-    end
-    _restructure(dc.du, dc.any_du)
-end
-
-end
+module SymbolicsPreallocationToolsExt
+
+using PreallocationTools
+import PreallocationTools: _restructure, get_tmp
+using Symbolics, ForwardDiff
+
+function get_tmp(dc::DiffCache, u::Type{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
+    if length(dc.du) > length(dc.any_du)
+        resize!(dc.any_du, length(dc.du))
+    end
+    _restructure(dc.du, dc.any_du)
+end
+
+function get_tmp(dc::DiffCache, u::X) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
+    if length(dc.du) > length(dc.any_du)
+        resize!(dc.any_du, length(dc.du))
+    end
+    _restructure(dc.du, dc.any_du)
+end
+
+function get_tmp(dc::DiffCache, u::AbstractArray{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
+    if length(dc.du) > length(dc.any_du)
+        resize!(dc.any_du, length(dc.du))
+    end
+    _restructure(dc.du, dc.any_du)
+end
+
+function get_tmp(dc::FixedSizeDiffCache, u::Type{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
+    if length(dc.du) > length(dc.any_du)
+        resize!(dc.any_du, length(dc.du))
+    end
+    _restructure(dc.du, dc.any_du)
+end
+
+function get_tmp(dc::FixedSizeDiffCache, u::X) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
+    if length(dc.du) > length(dc.any_du)
+        resize!(dc.any_du, length(dc.du))
+    end
+    _restructure(dc.du, dc.any_du)
+end
+
+function get_tmp(dc::FixedSizeDiffCache, u::AbstractArray{X}) where {T,N, X<: ForwardDiff.Dual{T, Num, N}}
+    if length(dc.du) > length(dc.any_du)
+        resize!(dc.any_du, length(dc.du))
+    end
+    _restructure(dc.du, dc.any_du)
+end
+
+end

test/nested_forwarddiff_sparsity.jl

@@ -1,23 +1,23 @@
-using ForwardDiff, SparseArrays, Symbolics, PreallocationTools
-# Test Nesting https://discourse.julialang.org/t/preallocationtools-jl-with-nested-forwarddiff-and-sparsity-pattern-detection-errors/107897
-
-function foo(x, cache)
-    d = get_tmp(cache, x)
-
-    d[:] = x
-
-    0.5 * x'*x
-end
-
-function residual(r, x, cache)
-    function foo_wrap(x)
-        foo(x, cache)
-    end
-
-    r[:] = ForwardDiff.gradient(foo_wrap, x)
-end
-
-cache = DiffCache(zeros(2))
-pattern = Symbolics.jacobian_sparsity((r, x) -> residual(r, x, cache), zeros(2), zeros(2))
-@test pattern == sparse([1 0
-                         0 1])
+using ForwardDiff, SparseArrays, Symbolics, PreallocationTools, Test
+# Test Nesting https://discourse.julialang.org/t/preallocationtools-jl-with-nested-forwarddiff-and-sparsity-pattern-detection-errors/107897
+
+function foo(x, cache)
+    d = get_tmp(cache, x)
+
+    d[:] = x
+
+    0.5 * x'*x
+end
+
+function residual(r, x, cache)
+    function foo_wrap(x)
+        foo(x, cache)
+    end
+
+    r[:] = ForwardDiff.gradient(foo_wrap, x)
+end
+
+cache = DiffCache(zeros(2))
+pattern = Symbolics.jacobian_sparsity((r, x) -> residual(r, x, cache), zeros(2), zeros(2))
+@test pattern == sparse([1 0
+                         0 1])