feat: V4

.github/workflows/benchmark_pr.yml

@@ -4,75 +4,22 @@ on:
   pull_request_target:
     branches:
       - master
+      - v4
 
 permissions:
   pull-requests: write
 
 jobs:
-    generate_plots:
-        runs-on: ubuntu-latest
-
-        steps:
-            - uses: actions/checkout@v4
-            - uses: julia-actions/setup-julia@v2
-              with:
-                version: "1"
-            - uses: julia-actions/cache@v2
-            - name: Extract Package Name from Project.toml
-              id: extract-package-name
-              run: |
-                PACKAGE_NAME=$(grep "^name" Project.toml | sed 's/^name = "\(.*\)"$/\1/')
-                echo "::set-output name=package_name::$PACKAGE_NAME"
-            - name: Build AirspeedVelocity
-              env:
-                JULIA_NUM_THREADS: 2
-              run: |
-                # Lightweight build step, as sometimes the runner runs out of memory:
-                julia -e 'ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0; import Pkg; Pkg.add("AirspeedVelocity")'
-                julia -e 'ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0; import Pkg; Pkg.build("AirspeedVelocity")'
-            - name: Add ~/.julia/bin to PATH
-              run: |
-                echo "$HOME/.julia/bin" >> $GITHUB_PATH
-            - name: Run benchmarks
-              run: |
-                echo $PATH
-                ls -l ~/.julia/bin
-                mkdir results
-                benchpkg ${{ steps.extract-package-name.outputs.package_name }} --rev="${{github.event.repository.default_branch}},${{github.event.pull_request.head.sha}}" --url=${{ github.event.repository.clone_url }} --bench-on="${{github.event.repository.default_branch}}" --output-dir=results/ --tune --exeflags="-O3 --threads=auto"
-            - name: Create plots from benchmarks
-              run: |
-                mkdir -p plots
-                benchpkgplot ${{ steps.extract-package-name.outputs.package_name }} --rev="${{github.event.repository.default_branch}},${{github.event.pull_request.head.sha}}" --npart=10 --format=png --input-dir=results/ --output-dir=plots/
-            - name: Upload plot as artifact
-              uses: actions/upload-artifact@v4
-              with:
-                name: plots
-                path: plots
-            - name: Create markdown table from benchmarks
-              run: |
-                benchpkgtable ${{ steps.extract-package-name.outputs.package_name }} --rev="${{github.event.repository.default_branch}},${{github.event.pull_request.head.sha}}" --input-dir=results/ --ratio > table.md
-                echo '### Benchmark Results' > body.md
-                echo '' >> body.md
-                echo '' >> body.md
-                cat table.md >> body.md
-                echo '' >> body.md
-                echo '' >> body.md
-                echo '### Benchmark Plots' >> body.md
-                echo 'A plot of the benchmark results have been uploaded as an artifact to the workflow run for this PR.' >> body.md
-                echo 'Go to "Actions"->"Benchmark a pull request"->[the most recent run]->"Artifacts" (at the bottom).' >> body.md
-
-            - name: Find Comment
-              uses: peter-evans/find-comment@v2
-              id: fcbenchmark
-              with:
-                issue-number: ${{ github.event.pull_request.number }}
-                comment-author: 'github-actions[bot]'
-                body-includes: Benchmark Results
-
-            - name: Comment on PR
-              uses: peter-evans/create-or-update-comment@v3
-              with:
-                comment-id: ${{ steps.fcbenchmark.outputs.comment-id }}
-                issue-number: ${{ github.event.pull_request.number }}
-                body-path: body.md
-                edit-mode: replace
+  bench:
+    name: "Benchmarks"
+    strategy:
+      matrix:
+        version:
+          - "1"
+          - "lts"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: MilesCranmer/AirspeedVelocity.jl@action-v1
+        with:
+          julia-version: "${{ matrix.version }}"
+          script: "benchmark/benchmarks.jl"

.github/workflows/ci.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - master
+      - v4
   push:
     branches:
       - master
@@ -20,6 +21,7 @@ jobs:
         version:
           - 'min'
           - '1'
+      fail-fast: false
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2

Project.toml

@@ -6,51 +6,67 @@ version = "3.32.0"
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
-Bijections = "e2ed5e7c-b2de-5872-ae92-c73ca462fb04"
-ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
 Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
+ConcurrentUtilities = "f0e56b4a-5159-44fe-b623-3e5288b988bb"
 ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 DynamicPolynomials = "7c1d4256-1411-5781-91ec-d7bc3513ac07"
+EnumX = "4e289a0a-7415-4d19-859d-a7e5c4648b56"
 ExproniconLite = "55351af7-c7e9-48d6-89ff-24e801d99491"
 LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
+Moshi = "2e0e35c7-a2e4-4343-998d-7ef72827ed2d"
 MultivariatePolynomials = "102ac46a-7ee4-5c85-9060-abc95bfdeaa3"
+MutableArithmetics = "d8a4904e-b15c-11e9-3269-09a3773c0cb0"
 NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
+ReadOnlyArrays = "988b38a3-91fc-5605-94a2-ee2116b3bd83"
 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"
 TaskLocalValues = "ed4db957-447d-4319-bfb6-7fa9ae7ecf34"
 TermInterface = "8ea1fca8-c5ef-4a55-8b96-4e9afe9c9a3c"
-TimerOutputs = "a759f4b9-e2f1-59dc-863e-4aeb61b1ea8f"
-Unityper = "a7c27f48-0311-42f6-a7f8-2c11e75eb415"
+WeakCacheSets = "d30d5f5c-d141-4870-aa07-aabb0f5fe7d5"
 
 [weakdeps]
+ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
 LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800"
 ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
 
+[sources]
+DynamicPolynomials = {rev = "as/new-poly-merge", url = "https://github.com/AayushSabharwal/DynamicPolynomials.jl"}
+MultivariatePolynomials = {rev = "as/poly-merge-nonconcrete", url = "https://github.com/AayushSabharwal/MultivariatePolynomials.jl"}
+MutableArithmetics = {rev = "as+bl/simplify_promote_type_fallback", url = "https://github.com/AayushSabharwal/MutableArithmetics.jl"}
+
 [extensions]
+SymbolicUtilsChainRulesCoreExt = "ChainRulesCore"
 SymbolicUtilsLabelledArraysExt = "LabelledArrays"
 SymbolicUtilsReverseDiffExt = "ReverseDiff"
 
 [compat]
 AbstractTrees = "0.4"
 ArrayInterface = "7.8"
-Bijections = "0.1.2, 0.2"
 ChainRulesCore = "1"
 Combinatorics = "1 - 1.0.2"
+ConcurrentUtilities = "2.5.0"
 ConstructionBase = "1.5.7"
 DataStructures = "0.18, 0.19"
 DocStringExtensions = "0.8, 0.9"
 DynamicPolynomials = "0.5, 0.6"
+EnumX = "1.0.5"
 ExproniconLite = "0.10.14"
 LabelledArrays = "1.5"
+LinearAlgebra = "1"
+MacroTools = "0.5.16"
+Moshi = "0.3.6"
 MultivariatePolynomials = "0.5"
+MutableArithmetics = "1.6.4"
 NaNMath = "0.3, 1.1.2"
 OhMyThreads = "0.7"
+ReadOnlyArrays = "0.2.0"
 ReverseDiff = "1"
 RuntimeGeneratedFunctions = "0.5.13"
 Setfield = "0.7, 0.8, 1"
@@ -59,8 +75,6 @@ StaticArrays = "0.12, 1.0"
 SymbolicIndexingInterface = "0.3"
 TaskLocalValues = "0.1.2"
 TermInterface = "2.0"
-TimerOutputs = "0.5"
-Unityper = "0.1.2"
 julia = "1.10"
 
 [extras]

bench.jl

@@ -0,0 +1,9 @@
+using SymbolicUtils, BenchmarkTools
+
+@syms a b c d e f g h i
+ex = (f + ((((g*(c^2)*(e^2)) / d - e*h*(c^2)) / b + (-c*e*f*g) / d + c*e*i) /
+                 (i + ((c*e*g) / d - c*h) / b + (-f*g) / d) - c*e) / b +
+            ((g*(f^2)) / d + ((-c*e*f*g) / d + c*f*h) / b - f*i) /
+            (i + ((c*e*g) / d - c*h) / b + (-f*g) / d)) / d
+
+@benchmark SymbolicUtils.fraction_iszero($ex)

benchmark/Project.toml

@@ -1 +1,5 @@
 [deps]
+
+[sources]
+WeakCacheSets = {url="https://github.com/JuliaCollections/WeakCacheSets.jl"}
+Moshi = {url="https://github.com/AayushSabharwal/Moshi.jl", rev="as/mutable-adt"}

benchmark/benchmarks.jl

@@ -7,6 +7,17 @@ SUITE = BenchmarkGroup()
 
 @syms a b c d x y[1:3] z[1:2, 1:2]; Random.seed!(123);
 
+function random_term(len; atoms, funs, fallback_atom=1)
+    xs = rand(atoms, len)
+    while length(xs) > 1
+        xs = map(Iterators.partition(xs, 2)) do xy
+            x = xy[1]; y = get(xy, 2, fallback_atom)
+            rand(funs)(x, y)
+        end
+    end
+    xs[]
+end
+
 let r = @rule(~x => ~x), rs = RuleSet([r]),
     acr = @rule(~x::is_literal_number + ~y => ~y)
 
@@ -34,16 +45,6 @@ let r = @rule(~x => ~x), rs = RuleSet([r]),
     overhead["simplify"]["noop:Sym"]  = @benchmarkable simplify($a)
     overhead["simplify"]["noop:Term"] = @benchmarkable simplify($(a+2))
 
-    function random_term(len; atoms, funs, fallback_atom=1)
-        xs = rand(atoms, len)
-        while length(xs) > 1
-            xs = map(Iterators.partition(xs, 2)) do xy
-                x = xy[1]; y = get(xy, 2, fallback_atom)
-                rand(funs)(x, y)
-            end
-        end
-        xs[]
-    end
     ex1 = random_term(1000, atoms=[a, b, c, d, a^(-1), b^(-1), 1, 2.0], funs=[+, *])
     ex2 = random_term(1000, atoms=[a, b, c, d, a^(-1), b^(-1), 1, 2.0], funs=[/, *])
 
@@ -55,15 +56,17 @@ let r = @rule(~x => ~x), rs = RuleSet([r]),
     overhead["substitute"] = BenchmarkGroup()
 
 
-    overhead["substitute"]["a"] = @benchmarkable substitute(subs_expr, $(Dict(a=>1))) setup=begin
+    # we use `fold = false` since otherwise it dynamic dispatches to `sin`/`cos` whenever
+    # both arguments in the contained addition are substituted.
+    overhead["substitute"]["a"] = @benchmarkable substitute(subs_expr, $(Dict(a=>1)); fold = false) setup=begin
         subs_expr = (sin(a+b) + cos(b+c)) * (sin(b+c) + cos(c+a)) * (sin(c+a) + cos(a+b))
     end
 
-    overhead["substitute"]["a,b"] = @benchmarkable substitute(subs_expr, $(Dict(a=>1, b=>2))) setup=begin
+    overhead["substitute"]["a,b"] = @benchmarkable substitute(subs_expr, $(Dict(a=>1, b=>2)); fold = false) setup=begin
         subs_expr = (sin(a+b) + cos(b+c)) * (sin(b+c) + cos(c+a)) * (sin(c+a) + cos(a+b))
     end
 
-    overhead["substitute"]["a,b,c"] = @benchmarkable substitute(subs_expr, $(Dict(a=>1, b=>2, c=>3))) setup=begin
+    overhead["substitute"]["a,b,c"] = @benchmarkable substitute(subs_expr, $(Dict(a=>1, b=>2, c=>3)); fold = false) setup=begin
         subs_expr = (sin(a+b) + cos(b+c)) * (sin(b+c) + cos(c+a)) * (sin(c+a) + cos(a+b))
     end
 
@@ -94,6 +97,38 @@ let
          (-f*(g + (-d*g) / d)) / (i + (-c*(h + (-e*g) / d)) / b + (-f*g) / d)) / d
     pform["simplify_fractions"] = @benchmarkable simplify_fractions($ex)
     pform["iszero"] = @benchmarkable SymbolicUtils.fraction_iszero($ex)
-    pform["isone"] = @benchmarkable SymbolicUtils.fraction_isone($o)
+    pform["isone"] = @benchmarkable SymbolicUtils.fraction_isone($ex)
+    pform["isone:noop"] = @benchmarkable SymbolicUtils.fraction_isone($o)
+    pform["iszero:noop"] = @benchmarkable SymbolicUtils.fraction_iszero($o)
     pform["easy_iszero"] = @benchmarkable SymbolicUtils.fraction_iszero($((b*(h + (-e*g) / d)) / b + (e*g) / d - h))
 end
+
+let
+    arith = SUITE["arithmetic"] = BenchmarkGroup()
+    atoms = [a, b, c, d, a^2, b^2, a^1.5, (b + c), b^c, 1, 2.0]
+    funs = [+, *]
+    exs = [random_term(5; atoms, funs) for _ in 1:50]
+    @static if isdefined(SymbolicUtils, :SymReal)
+        arith["addition"] = @benchmarkable SymbolicUtils.add_worker(SymReal, $exs)
+    elseif isdefined(SymbolicUtils, :add_worker)
+        arith["addition"] = @benchmarkable SymbolicUtils.add_worker($exs)
+    else
+        exs = Tuple(exs)
+        arith["addition"] = @benchmarkable +($(exs)...)
+    end
+
+    funs = [*, /]
+    exs = [random_term(5; atoms, funs) for _ in 1:50]
+    @static if isdefined(SymbolicUtils, :SymReal)
+        arith["multiplication"] = @benchmarkable SymbolicUtils.mul_worker(SymReal, $exs)
+    elseif isdefined(SymbolicUtils, :mul_worker)
+        arith["multiplication"] = @benchmarkable SymbolicUtils.mul_worker($exs)
+    else
+        exs = Tuple(exs)
+        arith["multiplication"] = @benchmarkable *($(exs)...)
+    end
+
+    ex1 = random_term(50; atoms, funs)
+    ex2 = random_term(50; atoms, funs)
+    arith["division"] = @benchmarkable $ex1 / $ex2
+end

docs/src/manual/rewrite.md

@@ -20,7 +20,7 @@ r1 = @rule sin(2(~x)) => 2sin(~x)*cos(~x)
 r1(sin(2z))
 
 # output
-2sin(z)*cos(z)
+2cos(z)*sin(z)
 ```
 
 The `@rule` macro takes a pair of patterns -- the _matcher_ and the _consequent_ (`@rule matcher => consequent`). If an expression matches the matcher pattern, it is rewritten to the consequent pattern. `@rule` returns a callable object that applies the rule to an expression.
@@ -40,7 +40,7 @@ Slot variable (matcher) is not necessary a single variable:
 r1(sin(2*(w-z)))
 
 # output
-2cos(w - z)*sin(w - z)
+2sin(w - z)*cos(w - z)
 ```
 
 And can also match a function:
@@ -61,7 +61,7 @@ r2 = @rule sin(~x + ~y) => sin(~x)*cos(~y) + cos(~x)*sin(~y);
 r2(sin(α+β))
 
 # output
-sin(β)*cos(α) + cos(β)*sin(α)
+cos(β)*sin(α) + sin(β)*cos(α)
 ```
 
 Now let's say you want to catch the coefficients of a second degree polynomial in z. You can do that with:
@@ -102,10 +102,10 @@ If you want to match a variable number of subexpressions at once, you will need
 @rule(+(~~xs) => ~~xs)(x + y + z)
 
 # output
-3-element view(::SymbolicUtils.SmallVec{Any, Vector{Any}}, 1:3) with eltype Any:
- z
- y
+3-element view(::ReadOnlyArrays.ReadOnlyVector{Any, SymbolicUtils.SmallVec{Any, Vector{Any}}}, 1:3) with eltype Any:
  x
+ y
+ z
 ```
 
 `~~xs` is a vector of subexpressions matched. You can use it to construct something more useful:

ext/SymbolicUtilsChainRulesCoreExt.jl

@@ -0,0 +1,16 @@
+module SymbolicUtilsChainRulesCoreExt
+
+using ChainRulesCore
+import ChainRulesCore: rrule
+import SymbolicUtils.Code
+
+function rrule(::typeof(Code.create_array), A::Type{<:AbstractArray}, T, u::Val{j}, d::Val{dims}, elems...) where {dims, j}
+  y = Code.create_array(A, T, u, d, elems...)
+  function create_array_pullback(Δ)
+    dx = Δ
+    (ZeroTangent(), NoTangent(), NoTangent(), NoTangent(), NoTangent(), dx..., ntuple(_ -> NoTangent(), length(elems) - prod(dims) + j)...)
+  end
+  y, create_array_pullback
+end
+
+end