Merge pull request #1649 from JuliaSymbolics/as/su-v4

[BREAKING] feat: update to SymbolicUtils@4

Author: AayushSabharwal

Project.toml

@@ -1,7 +1,7 @@
 name = "Symbolics"
 uuid = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 authors = ["Shashi Gowda <[email protected]>"]
-version = "6.57.0"
+version = "7.0.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
@@ -11,25 +11,24 @@ CommonWorldInvalidations = "f70d9fcc-98c5-4d4a-abd7-e4cdeebd8ca8"
 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"
-LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
-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"
+Moshi = "2e0e35c7-a2e4-4343-998d-7ef72827ed2d"
+MultivariatePolynomials = "102ac46a-7ee4-5c85-9060-abc95bfdeaa3"
+MutableArithmetics = "d8a4904e-b15c-11e9-3269-09a3773c0cb0"
 NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
-OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
+Preferences = "21216c6a-2e73-6563-6e65-726566657250"
 Primes = "27ebfcd6-29c5-5fa9-bf4b-fb8fc14df3ae"
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 RuntimeGeneratedFunctions = "7e49a35a-f44a-4d26-94aa-eba1b4ca6b47"
-SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 SciMLPublic = "431bcebd-1456-4ced-9d72-93c2757fff0b"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
@@ -42,20 +41,27 @@ TermInterface = "8ea1fca8-c5ef-4a55-8b96-4e9afe9c9a3c"
 
 [weakdeps]
 D3Trees = "e3df1716-f71e-5df9-9e2d-98e193103c45"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 Groebner = "0b43b601-686d-58a3-8a1c-6623616c7cd4"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 Lux = "b2108857-7c20-44ae-9111-449ecde12c47"
 Nemo = "2edaba10-b0f1-5616-af89-8c11ac63239a"
+PlutoRunner = "dc6b355a-2368-4481-ae6d-ae0351418d79"
 PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
 SymPy = "24249f21-da20-56a4-8eb1-6a02cf4ae2e6"
 SymPyPythonCall = "bc8888f7-b21e-4b7c-a06a-5d9c9496438c"
 
 [extensions]
 SymbolicsD3TreesExt = "D3Trees"
+SymbolicsDistributionsExt = "Distributions"
 SymbolicsForwardDiffExt = "ForwardDiff"
 SymbolicsGroebnerExt = "Groebner"
+SymbolicsLatexifyExt = ["Latexify", "LaTeXStrings"]
 SymbolicsLuxExt = "Lux"
 SymbolicsNemoExt = "Nemo"
+SymbolicsPlutoRunnerExt = "PlutoRunner"
 SymbolicsPreallocationToolsExt = ["PreallocationTools", "ForwardDiff"]
 SymbolicsSymPyExt = "SymPy"
 SymbolicsSymPyPythonCallExt = "SymPyPythonCall"
@@ -84,19 +90,21 @@ Latexify = "0.16"
 LogExpFunctions = "0.3"
 Lux = "1"
 MacroTools = "0.5"
+Moshi = "0.3.7"
+MultivariatePolynomials = "0.5.12"
+MutableArithmetics = "1.6.5"
 NaNMath = "1"
 Nemo = "0.46, 0.47, 0.48, 0.49, 0.52"
-OffsetArrays = "1.15.0"
 PkgBenchmark = "0.2"
 PreallocationTools = "0.4"
 PrecompileTools = "1"
+Preferences = "1.5.0"
 Primes = "0.5"
 RecipesBase = "1.1"
 Reexport = "1"
 ReferenceTests = "0.10"
 RuntimeGeneratedFunctions = "0.5.9"
 SafeTestsets = "0.1.0"
-SciMLBase = "2"
 SciMLPublic = "1.0.0"
 Setfield = "1"
 SnoopCompile = "3.1"
@@ -106,7 +114,7 @@ SymPy = "2.2"
 SymPyPythonCall = "0.5"
 SymbolicIndexingInterface = "0.3.14"
 SymbolicLimits = "0.2.2"
-SymbolicUtils = "3.24"
+SymbolicUtils = "4.3"
 TermInterface = "2"
 julia = "1.10"
 
@@ -117,7 +125,9 @@ D3Trees = "e3df1716-f71e-5df9-9e2d-98e193103c45"
 DynamicQuantities = "06fc5a27-2a28-4c7c-a15d-362465fb6821"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 Groebner = "0b43b601-686d-58a3-8a1c-6623616c7cd4"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LambertW = "984bce1d-4616-540c-a9ee-88d1112d94c9"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
 Lux = "b2108857-7c20-44ae-9111-449ecde12c47"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PkgBenchmark = "32113eaa-f34f-5b0d-bd6c-c81e245fc73d"
@@ -126,8 +136,7 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 SnoopCompile = "aa65fe97-06da-5843-b5b1-d5d13cad87d2"
-SymPyPythonCall = "bc8888f7-b21e-4b7c-a06a-5d9c9496438c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "SafeTestsets", "Pkg", "PkgBenchmark", "PreallocationTools", "ForwardDiff", "Groebner", "BenchmarkTools", "ReferenceTests", "SymPyPythonCall", "Random", "LambertW", "Lux", "ComponentArrays", "Nemo", "DynamicQuantities", "D3Trees", "SnoopCompile"]
+test = ["Test", "SafeTestsets", "Pkg", "PkgBenchmark", "PreallocationTools", "ForwardDiff", "Groebner", "BenchmarkTools", "ReferenceTests", "Random", "LambertW", "Lux", "ComponentArrays", "Nemo", "DynamicQuantities", "D3Trees", "SnoopCompile", "Latexify", "LaTeXStrings"]

docs/Project.toml

@@ -4,7 +4,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Groebner = "0b43b601-686d-58a3-8a1c-6623616c7cd4"
 Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
 Nemo = "2edaba10-b0f1-5616-af89-8c11ac63239a"
-OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
+# OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
@@ -16,8 +16,8 @@ Documenter = "1"
 Groebner = "0.8.2, 0.9, 0.10"
 Latexify = "0.15, 0.16"
 Nemo = "0.46, 0.47, 0.48, 0.49, 0.52"
-OrdinaryDiffEq = "6.31"
+# OrdinaryDiffEq = "6.31"
 Plots = "1.36"
 StaticArrays = "1.5"
-SymbolicUtils = "2.0.2, 3"
-Symbolics = "6"
+SymbolicUtils = "4.2"
+Symbolics = "7"

docs/src/manual/functions.md

@@ -95,19 +95,18 @@ also supplied.
 
 ### Defining Derivatives of Registered Functions
 
-In order for symbolic differentiation to work, an overload of `Symbolics.derivative` is
-required. The syntax is `derivative(typeof(f), args::NTuple{i,Any}, ::Val{j})` where
-`i` is the number of arguments to the function and `j` is which argument is being
-differentiated. So for example:
+In order for symbolic differentiation to work, defining [`@register_derivative`](@ref) for
+registered functions is required. For example,
 
 ```julia
-function derivative(::typeof(min), args::NTuple{2,Any}, ::Val{1})
-    x, y = args
-    ifelse(x < y, one(x), zero(x))
-end
+@register_derivative min(x, y) 1 ifelse(x < y, 1, 0)
 ```
 
-is the partial derivative of the Julia `min(x,y)` function with respect to `x`.
+is the partial derivative of the Julia `min(x,y)` function with respect to `x`. Refer to
+the documentation of [`@register_derivative`](@ref) for an in-depth explanation of the macro
+syntax.
+
+Querying the rules defined using this method requires the use of [`@derivative_rule`](@ref).
 
 !!! note
     Downstream symbolic derivative functionality only work if every partial derivative that
@@ -147,6 +146,8 @@ Note that at this time array derivatives cannot be defined.
 ```@docs
 @register_symbolic
 @register_array_symbolic
+@register_derivative
+@derivative_rule
 ```
 
 ## Direct Registration API (Advanced, Experimental)
@@ -181,11 +182,12 @@ Additionally a symbolic name is required:
 Base.nameof(interp::AbstractInterpolation) = :Interpolation
 ```
 
-The derivative is defined similarly to the macro case:
+With Symbolics.jl v7 we don't expose a direct API for defining derivatives. It
+requires using the macro.
 
 ```julia
-function Symbolics.derivative(interp::AbstractInterpolation, args::NTuple{1, Any}, ::Val{1})
-    Symbolics.unwrap(derivative(interp, Symbolics.wrap(args[1])))
+@register_derivative (interp::AbstractInterpolation)(x) 1 begin
+    # ...
 end
 ```
 

docs/src/tutorials/auto_parallel.md

@@ -84,7 +84,7 @@ Now let's set up the parabolic PDE to be solved by DifferentialEquations.jl.
 We will set up the vanilla version and the sparse multithreaded
 version:
 
-```@example auto_parallel
+```julia
 using OrdinaryDiffEq
 u0 = zeros(N, N, 3)
 MyA = zeros(N, N);
@@ -99,7 +99,7 @@ fastprob = ODEProblem(ODEFunction((du, u, p, t) -> fastf(du, u),
 
 Let's see the timing difference:
 
-```@example auto_parallel
+```julia
 using BenchmarkTools
 #@btime solve(prob, TRBDF2()); # 33.073 s (895404 allocations: 23.87 GiB)
 #warning the following solve takes a long time to compile, but afterwards is very fast.

ext/SymbolicsDistributionsExt.jl

@@ -0,0 +1,37 @@
+module SymbolicsDistributionsExt
+
+using Symbolics
+using Distributions
+using Symbolics: Num, Arr, VartypeT, unwrap, BasicSymbolic, shape
+
+
+for f in [pdf, logpdf, cdf, logcdf, quantile]
+    @eval function (::$(typeof(f)))(dist::Distributions.Distribution, x::Num)
+        $f(dist, unwrap(x))
+    end
+    @eval function (::$(typeof(f)))(dist::Distributions.Distribution, x::Arr)
+        $f(dist, unwrap(x))
+    end
+    @eval function (::$(typeof(f)))(dist::BasicSymbolic{VartypeT}, x::Num)
+        $f(dist, unwrap(x))
+    end
+    @eval function (::$(typeof(f)))(dist::BasicSymbolic{VartypeT}, x::Arr)
+        $f(dist, unwrap(x))
+    end
+    @eval function (::$(typeof(f)))(dist::BasicSymbolic{VartypeT}, x)
+        $f(dist, unwrap(x))
+    end
+end
+
+for f in [Distributions.Uniform, Distributions.Normal]
+    for (T1, T2) in Iterators.product(Iterators.repeated([Real, BasicSymbolic{VartypeT}, Num], 2)...)
+        if T1 != Num && T2 != Num
+            continue
+        end
+        @eval function (::Type{$f})(a::$T1, b::$T2)
+            $f(unwrap(a), unwrap(b))
+        end
+    end
+end
+
+end