Let's go!

Merge branch 's/terminterface1' into ale/terminterface-new

Author: Shashi Gowda

Project.toml

@@ -43,6 +43,7 @@ Setfield = "0.7, 0.8, 1"
 SpecialFunctions = "0.10, 1.0, 2"
 StaticArrays = "0.12, 1.0"
 SymbolicIndexingInterface = "0.3"
+TermInterface = "0.4"
 TimerOutputs = "0.5"
 Unityper = "0.1.2"
 julia = "1.3"

src/SymbolicUtils.jl

@@ -4,22 +4,23 @@ $(DocStringExtensions.README)
 module SymbolicUtils
 
 using DocStringExtensions
+
 export @syms, term, showraw, hasmetadata, getmetadata, setmetadata
 
 using Unityper
-
-# Sym, Term,
-# Add, Mul and Pow
+using TermInterface
 using DataStructures
 using Setfield
 import Setfield: PropertyLens
 using SymbolicIndexingInterface
 import Base: +, -, *, /, //, \, ^, ImmutableDict
 using ConstructionBase
 using TermInterface
-import TermInterface: iscall, isexpr, issym, symtype, head, children, operation, arguments, metadata
+import TermInterface: iscall, isexpr, issym, symtype, head, children,
+                      operation, arguments, metadata, maketerm
 
-function similarterm end
+# Sym, Term,
+# Add, Mul and Pow
 include("types.jl")
 export similarterm
 

src/inspect.jl

@@ -2,7 +2,7 @@ import AbstractTrees
 
 const inspect_metadata = Ref{Bool}(false)
 function AbstractTrees.nodevalue(x::Symbolic)
-    iscall(x) ? operation(x) : x
+    iscall(x) ? operation(x) : isexpr(x) ? head(x) : x
 end
 
 function AbstractTrees.nodevalue(x::BasicSymbolic)
@@ -27,7 +27,7 @@ function AbstractTrees.nodevalue(x::BasicSymbolic)
 end
 
 function AbstractTrees.children(x::Symbolic)
-    isexpr(x) ? arguments(x) : ()
+    iscall(x) ? arguments(x) : isexpr(x) ? children(x) : ()
 end
 
 """

src/interface.jl

@@ -1,10 +1,10 @@
 """
-  istree(x)
+  iscall(x)
 
 Returns `true` if `x` is a term. If true, `operation`, `arguments`
 must also be defined for `x` appropriately.
 """
-istree(x) = false
+iscall(x) = false
 
 """
   symtype(x)
@@ -29,7 +29,7 @@ issym(x) = false
 """
   operation(x)
 
-If `x` is a term as defined by `istree(x)`, `operation(x)` returns the
+If `x` is a term as defined by `iscall(x)`, `operation(x)` returns the
 head of the term if `x` represents a function call, for example, the head
 is the function being called.
 """
@@ -38,14 +38,14 @@ function operation end
 """
   arguments(x)
 
-Get the arguments of `x`, must be defined if `istree(x)` is `true`.
+Get the arguments of `x`, must be defined if `iscall(x)` is `true`.
 """
 function arguments end
 
 """
   unsorted_arguments(x::T)
 
-If x is a term satisfying `istree(x)` and your term type `T` provides
+If x is a term satisfying `iscall(x)` and your term type `T` provides
 an optimized implementation for storing the arguments, this function can
 be used to retrieve the arguments when the order of arguments does not matter 
 but the speed of the operation does.

src/matchers.jl

@@ -6,7 +6,7 @@
 # 3. Callback: takes arguments Dictionary × Number of elements matched
 #
 function matcher(val::Any)
-    isexpr(val) && return term_matcher(val)
+    iscall(val) && return term_matcher(val)
     function literal_matcher(next, data, bindings)
         islist(data) && isequal(car(data), val) ? next(bindings, 1) : nothing
     end

src/polyform.jl

@@ -6,7 +6,7 @@ using Bijections
 
 Abstracts a [MultivariatePolynomials.jl](https://juliaalgebra.github.io/MultivariatePolynomials.jl/stable/) as a SymbolicUtils expression and vice-versa.
 
-The SymbolicUtils term interface (`isexpr`, `operation, and `arguments`) works on PolyForm lazily:
+The SymbolicUtils term interface (`isexpr`/`iscall`, `operation, and `arguments`) works on PolyForm lazily:
 the `operation` and `arguments` are created by converting one level of arguments into SymbolicUtils expressions. They may further contain PolyForm within them.
 We use this to hold polynomials in memory while doing `simplify_fractions`.
 
@@ -175,7 +175,6 @@ isexpr(x::PolyForm) = true
 iscall(x::Type{<:PolyForm}) = true
 iscall(x::PolyForm) = true
 
-
 function similarterm(t::PolyForm, f, args, symtype; metadata=nothing)
     basic_similarterm(t, f, args, symtype; metadata=metadata)
 end

src/rule.jl

@@ -120,7 +120,7 @@ end
 getdepth(r::Rule) = r.depth
 
 function rule_depth(rule, d=0, maxdepth=0)
-    if isexpr(rule)
+    if iscall(rule)
         maxdepth = reduce(max, (rule_depth(r, d+1, maxdepth) for r in arguments(rule)), init=1)
     elseif rule isa Slot || rule isa Segment
         maxdepth = max(d, maxdepth)
@@ -389,7 +389,7 @@ Base.show(io::IO, acr::ACRule) = print(io, "ACRule(", acr.rule, ")")
 
 function (acr::ACRule)(term)
     r = Rule(acr)
-    if !isexpr(term)
+    if !iscall(term)
         r(term)
     else
         f =  operation(term)

src/types.jl

@@ -113,6 +113,7 @@ symtype(x::Number) = typeof(x)
         _    => error_on_type()
     end
 end
+
 @inline head(x::BasicSymbolic) = BasicSymbolic
 
 function arguments(x::BasicSymbolic)
@@ -159,7 +160,7 @@ function unsorted_arguments(x::BasicSymbolic)
     if isadd(x)
         for (k, v) in x.dict
             push!(args, applicable(*,k,v) ? k*v :
-                    similarterm(k, *, [k, v]))
+                    maketerm(k, *, [k, v]))
         end
     else # MUL
         for (k, v) in x.dict
@@ -187,6 +188,7 @@ end
 
 isexpr(s::BasicSymbolic) = !issym(s)
 iscall(s::BasicSymbolic) = isexpr(s)
+
 @inline isa_SymType(T::Val{S}, x) where {S} = x isa BasicSymbolic ? Unityper.isa_type_fun(Val(SymbolicUtils.BasicSymbolic), T, x) : false
 issym(x::BasicSymbolic) = isa_SymType(Val(:Sym), x)
 isterm(x) = isa_SymType(Val(:Term), x)
@@ -531,30 +533,12 @@ end
 
 unflatten(t) = t
 
-"""
-    similarterm(t, f, args, symtype; metadata=nothing)
-
-Create a term that is similar in type to `t`. Extending this function allows packages
-using their own expression types with SymbolicUtils to define how new terms should
-be created. Note that `similarterm` may return an object that has a
-different type than `t`, because `f` also influences the result.
+function TermInterface.maketerm(::Type{<:BasicSymbolic}, head, args, type, metadata)
+    basicsymbolic(first(args), args[2:end], type, metadata)
+end
 
-## Arguments
 
-- `t` the reference term to use to create similar terms
-- `f` is the operation of the term
-- `args` is the arguments
-- The `symtype` of the resulting term. Best effort will be made to set the symtype of the
-  resulting similar term to this type.
-"""
-similarterm(t::Symbolic, f, args; metadata=nothing) =
-    maketerm(typeof(t), f, args, _promote_symtype(f, args); metadata)
-similarterm(t::BasicSymbolic, f, args, symtype; metadata=nothing) =
-    maketerm(typeof(t), f, args, symtype; metadata=metadata)
-maketerm(T::Type{<:Symbolic}, f, args, symtype; metadata=nothing) =
-    basic_similarterm(T, f, args, symtype; metadata=metadata)
-
-function basic_similarterm(t, f, args, stype; metadata=nothing)
+function basicsymbolic(f, args, stype, metadata)
     if f isa Symbol
         error("$f must not be a Symbol")
     end
@@ -564,7 +548,7 @@ function basic_similarterm(t, f, args, stype; metadata=nothing)
     end
     if T <: LiteralReal
         Term{T}(f, args, metadata=metadata)
-    elseif stype <: Number && (f in (+, *) || (f in (/, ^) && length(args) == 2)) && all(x->symtype(x) <: Number, args)
+    elseif T <: Number && (f in (+, *) || (f in (/, ^) && length(args) == 2)) && all(x->symtype(x) <: Number, args)
         res = f(args...)
         if res isa Symbolic
             @set! res.metadata = metadata
@@ -653,6 +637,36 @@ function to_symbolic(x)
     x
 end
 
+"""
+    similarterm(x, op, args, symtype=nothing; metadata=nothing)
+
+"""
+function similarterm(x, op, args, symtype=nothing; metadata=nothing)
+  Base.depwarn("""`similarterm` is deprecated, use `maketerm` instead.
+                  See https://github.com/JuliaSymbolics/TermInterface.jl for details.
+                  The present call can be replaced by
+                  `maketerm(typeof(x), $(head(x)), [op, args...], symtype, metadata)`""", :similarterm)
+
+  TermInterface.maketerm(typeof(x), callhead(x), [op, args...], symtype, metadata)
+end
+
+# Old fallback
+function similarterm(T::Type, op, args, symtype=nothing; metadata=nothing)
+  Base.depwarn("`similarterm` is deprecated, use `maketerm` instead." *
+               "See https://github.com/JuliaSymbolics/TermInterface.jl for details.", :similarterm)
+  op(args...)
+end
+
+export similarterm
+
+
+"""
+    callhead(x)
+Used in this deprecation cycle of `similarterm` to find the `head` argument to
+`maketerm`. Do not implement this, or use `similarterm` if you're using this package.
+"""
+callhead(x) = typeof(x)
+
 ###
 ###  Pretty printing
 ###

src/utils.jl

@@ -218,8 +218,8 @@ macro matchable(expr)
     get_name(e::Expr) = (@assert(e.head == :(::)); e.args[1])
     fields = map(get_name, fields)
     quote
+        # TODO: fix this to be not a call. Make pattern matcher work for these
         $expr
-        SymbolicUtils.iscall(::$name) = true
         SymbolicUtils.head(::$name) = $name
         SymbolicUtils.operation(::$name) = $name
         SymbolicUtils.arguments(x::$name) = getfield.((x,), ($(QuoteNode.(fields)...),))