Merge pull request #1677 from AayushSabharwal/as/fix-latexify

fix: fix latexification of equations

Author: AayushSabharwal

Project.toml

@@ -5,6 +5,7 @@ version = "7.0.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
+AbstractPlutoDingetjes = "6e696c72-6542-2067-7265-42206c756150"
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
 Bijections = "e2ed5e7c-b2de-5872-ae92-c73ca462fb04"
 CommonWorldInvalidations = "f70d9fcc-98c5-4d4a-abd7-e4cdeebd8ca8"
@@ -44,11 +45,10 @@ 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"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
 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"
@@ -61,13 +61,13 @@ SymbolicsGroebnerExt = "Groebner"
 SymbolicsLatexifyExt = ["Latexify", "LaTeXStrings"]
 SymbolicsLuxExt = "Lux"
 SymbolicsNemoExt = "Nemo"
-SymbolicsPlutoRunnerExt = "PlutoRunner"
 SymbolicsPreallocationToolsExt = ["PreallocationTools", "ForwardDiff"]
 SymbolicsSymPyExt = "SymPy"
 SymbolicsSymPyPythonCallExt = "SymPyPythonCall"
 
 [compat]
 ADTypes = "1.0"
+AbstractPlutoDingetjes = "1.3.2"
 ArrayInterface = "7"
 BenchmarkTools = "1.0"
 Bijections = "0.1, 0.2"

docs/src/manual/arrays.md

@@ -213,6 +213,6 @@ Symbolics.scalarize(sum(A[:,1]) + sum(A[2,:]))
 
 ```@docs
 Symbolics.Arr
-Symbolics.scalarize
-Symbolics.shape
+SymbolicUtils.scalarize
+SymbolicUtils.shape
 ```

docs/src/manual/derivatives.md

@@ -56,11 +56,12 @@ However, often you may want to define your own derivatives so that way
 automatic Jacobian etc. calculations can utilize this information. This can
 allow for more succinct versions of the derivatives to be calculated
 to scale to larger systems. You can define derivatives for your
-function via the dispatch:
+function via the macro:
 
 ```julia
-# `N` arguments are accepted by the relevant method of `my_function`
-Symbolics.derivative(::typeof(my_function), args::NTuple{N,Any}, ::Val{i})
+@register_derivative my_function(args...) i begin
+    # ...
+end
 ```
 
 where `i` means that it's the derivative with respect to the `i`th argument. `args` is the
@@ -70,5 +71,7 @@ You should return an `Term` for the derivative of your function.
 For example, `sin(t)`'s derivative (by `t`) is given by the following:
 
 ```@example derivatives
-Symbolics.derivative(::typeof(sin), args::NTuple{1,Any}, ::Val{1}) = cos(args[1])
+@register_derivative sin(t) 1 cos(t)
 ```
+
+For more information see [`@register_derivative`](@ref).

docs/src/manual/expression_manipulation.md

@@ -45,6 +45,6 @@ Symbolics.evaluate
 Symbolics.symbolic_to_float
 Symbolics.terms(x)
 Symbolics.factors(x)
-numerator(x::Union{Num, Symbolics.Symbolic})
-denominator(x::Union{Num, Symbolics.Symbolic})
+numerator(x::Union{Num, SymbolicUtils.BasicSymbolic})
+denominator(x::Union{Num, SymbolicUtils.BasicSymbolic})
 ```

docs/src/tutorials/perturbation.md

@@ -26,7 +26,7 @@ function solve_newton(eq, x, x₀; abstol=1e-8, maxiters=50)
     xₙ = x₀ # numerical value of the initial guess
     for i = 1:maxiters
         # calculate new guess by numerically evaluating symbolic expression at previous guess
-        xₙ₊₁ = substitute(x - f / f′, x => xₙ)
+        xₙ₊₁ = Symbolics.value(substitute(x - f / f′, x => xₙ; fold = Val(true)))
         if abs(xₙ₊₁ - xₙ) < abstol
             return xₙ₊₁ # converged
         else

ext/SymbolicsLatexifyExt.jl

@@ -140,7 +140,7 @@ end
     if hide_lhs(value(eq.lhs)) || !(value(eq.lhs) isa Union{Number, AbstractArray, BasicSymbolic})
         return value(eq.rhs)
     else
-        return Expr(:(=), wrap(value(eq.lhs)), wrap(value(eq.rhs)))
+        return Expr(:(=), recipe(eq.lhs), recipe(eq.rhs))
     end
 end
 

ext/SymbolicsPlutoRunnerExt.jl

@@ -82,8 +82,19 @@ const STerm = SymbolicUtils.Term{VartypeT}
 
 export simplify, substitute
 
-warn_load_latexify() = warn_load_latexify(nothing)
-warn_load_latexify(_) = nothing
+import AbstractPlutoDingetjes: is_inside_pluto
+const WARNED_LATEXIFY = Ref(false)
+function warn_load_latexify()
+    is_inside_pluto() || return
+    WARNED_LATEXIFY[] && return
+    @warn """
+    Attempting to print a symbolic expression in a Pluto notebook. Please run \
+    `import Latexify` to enable pretty-printing of symbolic expressions. This \
+    warning will only display once.
+    """
+    WARNED_LATEXIFY[] = true
+    return nothing
+end
 
 export Num
 import MacroTools: splitdef, combinedef, postwalk, striplines

src/Symbolics.jl

@@ -45,10 +45,8 @@ Dy = Differential(y)
 @test_reference "latexify_refs/stable_mul_ordering1.txt" latexify(x * y)
 @test_reference "latexify_refs/stable_mul_ordering2.txt" latexify(y * x)
 
-@test_throws TypeError latexify(x ~ y + z)
-# @test_reference "latexify_refs/equation1.txt" latexify(x ~ y + z)
-@test_throws TypeError latexify(x ~ Dx(y + z))
-# @test_reference "latexify_refs/equation2.txt" latexify(x ~ Dx(y + z))
+@test_reference "latexify_refs/equation1.txt" latexify(x ~ y + z)
+@test_reference "latexify_refs/equation2.txt" latexify(x ~ Dx(y + z))
 @test_reference "latexify_refs/equation5.txt" latexify(AA^2 + AA + 1 + X₁)
 
 @test_reference "latexify_refs/equation_vec1.txt" latexify([

test/latexify.jl

@@ -1,3 +1,3 @@
 \begin{equation}
-x = \frac{\mathrm{d}}{\mathrm{d}x} \left( y + z \right)
+x = \frac{\mathrm{d}}{\mathrm{d}x} \cdot \left( y + z \right)
 \end{equation}