feat: remove IfElse support

Author: AayushSabharwal

NEWS.md

@@ -49,3 +49,4 @@
     `(single_parameter => expression_involving_other_parameters)` and a `Vector` of these can be passed to
     the `parameter_dependencies` keyword argument of `ODESystem`, `SDESystem` and `JumpSystem`. The dependent
     parameters are updated whenever other parameters are modified, e.g. in callbacks.
+  - Support for `IfElse.jl` has been dropped. `Base.ifelse` can be used instead.

Project.toml

@@ -23,7 +23,6 @@ FindFirstFunctions = "64ca27bc-2ba2-4a57-88aa-44e436879224"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 FunctionWrappersWrappers = "77dc65aa-8811-40c2-897b-53d922fa7daf"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
-IfElse = "615f187c-cbe4-4ef1-ba3b-2fcf58d6d173"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 JumpProcesses = "ccbc3e58-028d-4f4c-8cd5-9ae44345cda5"
@@ -81,7 +80,6 @@ FindFirstFunctions = "1"
 ForwardDiff = "0.10.3"
 FunctionWrappersWrappers = "0.1"
 Graphs = "1.5.2"
-IfElse = "0.1"
 InteractiveUtils = "1"
 JuliaFormatter = "1.0.47"
 JumpProcesses = "9.1"

docs/src/basics/FAQ.md

@@ -24,12 +24,11 @@ pnew = varmap_to_vars([β => 3.0, c => 10.0, γ => 2.0], parameters(sys))
 
 ## How do I handle `if` statements in my symbolic forms?
 
-For statements that are in the `if then else` form, use `IfElse.ifelse` from the
-[IfElse.jl](https://github.com/SciML/IfElse.jl) package to represent the code in a
-functional form. For handling direct `if` statements, you can use equivalent boolean
-mathematical expressions. For example, `if x > 0 ...` can be implemented as just
-`(x > 0) * `, where if `x <= 0` then the boolean will evaluate to `0` and thus the
-term will be excluded from the model.
+For statements that are in the `if then else` form, use `Base.ifelse` from the
+to represent the code in a functional form. For handling direct `if` statements,
+you can use equivalent boolean mathematical expressions. For example, `if x > 0 ...`
+can be implemented as just `(x > 0) * `, where if `x <= 0` then the boolean will
+evaluate to `0` and thus the term will be excluded from the model.
 
 ## ERROR: TypeError: non-boolean (Num) used in boolean context?
 

src/ModelingToolkit.jl

@@ -27,7 +27,6 @@ using PrecompileTools, Reexport
     using DocStringExtensions
     using Base: RefValue
     using Combinatorics
-    import IfElse
     import Distributions
     import FunctionWrappersWrappers
     using URIs: URI

src/systems/unit_check.jl

@@ -1,5 +1,5 @@
 #For dispatching get_unit
-const Conditional = Union{typeof(ifelse), typeof(IfElse.ifelse)}
+const Conditional = Union{typeof(ifelse)}
 const Comparison = Union{typeof.([==, !=, ≠, <, <=, ≤, >, >=, ≥])...}
 
 struct ValidationError <: Exception

src/systems/validation.jl

@@ -1,6 +1,6 @@
 module UnitfulUnitCheck
 
-using ..ModelingToolkit, Symbolics, SciMLBase, Unitful, IfElse, RecursiveArrayTools
+using ..ModelingToolkit, Symbolics, SciMLBase, Unitful, RecursiveArrayTools
 using ..ModelingToolkit: ValidationError,
                          ModelingToolkit, Connection, instream, JumpType, VariableUnit,
                          get_systems,

test/domain_connectors.jl

@@ -1,7 +1,6 @@
 using ModelingToolkit
 using ModelingToolkit: t_nounits as t, D_nounits as D
 using Test
-using IfElse: ifelse
 
 @connector function HydraulicPort(; p_int, name)
     pars = @parameters begin

test/downstream/linearize.jl

@@ -163,7 +163,7 @@ end
 function saturation(; y_max, y_min = y_max > 0 ? -y_max : -Inf, name)
     @variables u(t)=0 y(t)=0
     @parameters y_max=y_max y_min=y_min
-    ie = ModelingToolkit.IfElse.ifelse
+    ie = ifelse
     eqs = [
     # The equation below is equivalent to y ~ clamp(u, y_min, y_max)
         y ~ ie(u > y_max, y_max, ie((y_min < u) & (u < y_max), u, y_min))

test/dq_units.jl

@@ -1,4 +1,4 @@
-using ModelingToolkit, OrdinaryDiffEq, JumpProcesses, IfElse, DynamicQuantities
+using ModelingToolkit, OrdinaryDiffEq, JumpProcesses, DynamicQuantities
 using Test
 MT = ModelingToolkit
 using ModelingToolkit: t, D

test/generate_custom_function.jl

@@ -1,6 +1,5 @@
 using ModelingToolkit
 using ModelingToolkit: t_nounits as t, D_nounits as D
-using IfElse
 
 @variables x(t) y(t)[1:3]
 @parameters p1=1.0 p2[1:3]=[1.0, 2.0, 3.0] p3::Int=1 p4::Bool=false
@@ -24,9 +23,9 @@ fn3_iip(buffer, u0, p, 1.0)
 @test buffer == [4.0, 6.0, 2.0, 3.0]
 @test fn3_oop(u0, p, 1.0) == [4.0, 6.0, 2.0, 3.0]
 
-fn4 = generate_custom_function(sys, IfElse.ifelse(p4, p1, p2[2]); expression = Val(false))
+fn4 = generate_custom_function(sys, ifelse(p4, p1, p2[2]); expression = Val(false))
 @test fn4(u0, p, 1.0) == 2.0
-fn5 = generate_custom_function(sys, IfElse.ifelse(!p4, p1, p2[2]); expression = Val(false))
+fn5 = generate_custom_function(sys, ifelse(!p4, p1, p2[2]); expression = Val(false))
 @test fn5(u0, p, 1.0) == 1.0
 
 @variables x y[1:3]
@@ -47,7 +46,7 @@ fn3_iip(buffer, u0, p)
 @test buffer == [4.0, 6.0, 2.0]
 @test fn3_oop(u0, p, 1.0) == [4.0, 6.0, 2.0]
 
-fn4 = generate_custom_function(sys, IfElse.ifelse(p4, p1, p2[2]); expression = Val(false))
+fn4 = generate_custom_function(sys, ifelse(p4, p1, p2[2]); expression = Val(false))
 @test fn4(u0, p, 1.0) == 2.0
-fn5 = generate_custom_function(sys, IfElse.ifelse(!p4, p1, p2[2]); expression = Val(false))
+fn5 = generate_custom_function(sys, ifelse(!p4, p1, p2[2]); expression = Val(false))
 @test fn5(u0, p, 1.0) == 1.0

test/state_selection.jl

@@ -1,4 +1,4 @@
-using ModelingToolkit, OrdinaryDiffEq, IfElse, Test
+using ModelingToolkit, OrdinaryDiffEq, Test
 using ModelingToolkit: t_nounits as t, D_nounits as D
 
 sts = @variables x1(t) x2(t) x3(t) x4(t)
@@ -249,7 +249,7 @@ let
     Δp2 = p2
 
     eqs = [+flow(xm, Δp1) ~ rho1 * dV1 + drho1 * V1
-           0 ~ IfElse.ifelse(w > 0.5,
+           0 ~ ifelse(w > 0.5,
                (0) - (rho2 * dV2 + drho2 * V2),
                (-flow(xm, Δp2)) - (rho2 * dV2 + drho2 * V2))
            V1 ~ (l_1f + w) * A_1f
@@ -265,7 +265,7 @@ let
            D(w) ~ dw
            D(dw) ~ ddw
            xf ~ 20e-3 * (1 - cos(2 * π * 5 * t))
-           0 ~ IfElse.ifelse(w > 0.5,
+           0 ~ ifelse(w > 0.5,
                (m_total * ddw) - (p1 * A_1f - p2 * A_2f - damp * dw),
                (m_total * ddw) - (p1 * A_1f - p2 * A_2f))]
     # ----------------------------------------------------------------------------

test/units.jl

@@ -1,4 +1,4 @@
-using ModelingToolkit, OrdinaryDiffEq, JumpProcesses, IfElse, Unitful
+using ModelingToolkit, OrdinaryDiffEq, JumpProcesses, Unitful
 using Test
 MT = ModelingToolkit
 UMT = ModelingToolkit.UnitfulUnitCheck
@@ -33,7 +33,7 @@ D = Differential(t)
 @test UMT.get_unit(t / τ) == UMT.unitless
 @test UMT.equivalent(UMT.get_unit(P - E / τ), u"MW")
 @test UMT.equivalent(UMT.get_unit(D(D(E))), u"MW/ms")
-@test UMT.get_unit(IfElse.ifelse(t > t, P, E / τ)) == u"MW"
+@test UMT.get_unit(ifelse(t > t, P, E / τ)) == u"MW"
 @test UMT.get_unit(1.0^(t / τ)) == UMT.unitless
 @test UMT.get_unit(exp(t / τ)) == UMT.unitless
 @test UMT.get_unit(sin(t / τ)) == UMT.unitless