feat: add missing_is_symbolic to remake

Author: AayushSabharwal

src/remake.jl

@@ -75,17 +75,22 @@ be interpreted as a symbolic map and used as-is for parameters. `use_defaults` a
 controlling whether the default values from the system will be used to calculate missing
 values in the symbolic map passed to `u0` or `p`. It is only valid when either `u0` or
 `p` have been explicitly provided as a symbolic map and the problem has an associated
-system.
+system. If `missing_is_symbolic`, not providing `u0`/`p` is interpreted as an empty symbolic
+map. Otherwise, they retain the existing value in `prob`. If neither `u0` nor `p` is provided,
+then they retain the existing values in `prob` regardless of `missing_is_symbolic`.
 """
 function remake(prob::AbstractSciMLProblem; u0 = missing,
-        p = missing, interpret_symbolicmap = true, use_defaults = false, kwargs...)
-    u0, p = updated_u0_p(prob, u0, p; interpret_symbolicmap, use_defaults)
+        p = missing, interpret_symbolicmap = true, use_defaults = false,
+        missing_is_symbolic = true, kwargs...)
+    u0, p = updated_u0_p(
+        prob, u0, p; interpret_symbolicmap, use_defaults, missing_is_symbolic)
     _remake_internal(prob; kwargs..., u0, p)
 end
 
 function remake(prob::AbstractIntervalNonlinearProblem; p = missing,
-        interpret_symbolicmap = true, use_defaults = false, kwargs...)
-    _, p = updated_u0_p(prob, [], p; interpret_symbolicmap, use_defaults)
+        interpret_symbolicmap = true, use_defaults = false, missing_is_symbolic = true, kwargs...)
+    _, p = updated_u0_p(
+        prob, [], p; interpret_symbolicmap, use_defaults, missing_is_symbolic)
     _remake_internal(prob; kwargs..., p)
 end
 
@@ -94,8 +99,10 @@ function remake(prob::AbstractNoiseProblem; kwargs...)
 end
 
 function remake(
-        prob::AbstractIntegralProblem; p = missing, interpret_symbolicmap = true, use_defaults = false, kwargs...)
-    _, p = updated_u0_p(prob, nothing, p; interpret_symbolicmap, use_defaults)
+        prob::AbstractIntegralProblem; p = missing, interpret_symbolicmap = true,
+        use_defaults = false, missing_is_symbolic = true, kwargs...)
+    _, p = updated_u0_p(
+        prob, nothing, p; interpret_symbolicmap, use_defaults, missing_is_symbolic)
     _remake_internal(prob; kwargs..., p)
 end
 
@@ -114,12 +121,14 @@ function remake(prob::ODEProblem; f = missing,
         interpret_symbolicmap = true,
         build_initializeprob = true,
         use_defaults = false,
+        missing_is_symbolic = true,
         _kwargs...)
     if tspan === missing
         tspan = prob.tspan
     end
 
-    newu0, newp = updated_u0_p(prob, u0, p, tspan[1]; interpret_symbolicmap, use_defaults)
+    newu0, newp = updated_u0_p(
+        prob, u0, p, tspan[1]; interpret_symbolicmap, use_defaults, missing_is_symbolic)
 
     iip = isinplace(prob)
 
@@ -231,7 +240,8 @@ Remake the given `BVProblem`.
 """
 function remake(prob::BVProblem{uType, tType, iip, nlls}; f = missing, bc = missing,
         u0 = missing, tspan = missing, p = missing, kwargs = missing, problem_type = missing,
-        interpret_symbolicmap = true, use_defaults = false, _kwargs...) where {
+        interpret_symbolicmap = true, use_defaults = false, missing_is_symbolic = true,
+        _kwargs...) where {
         uType, tType, iip, nlls}
     if tspan === missing
         tspan = prob.tspan
@@ -296,14 +306,16 @@ function remake(prob::SDEProblem;
         noise_rate_prototype = missing,
         interpret_symbolicmap = true,
         use_defaults = false,
+        missing_is_symbolic = true,
         seed = missing,
         kwargs = missing,
         _kwargs...)
     if tspan === missing
         tspan = prob.tspan
     end
 
-    u0, p = updated_u0_p(prob, u0, p, tspan[1]; interpret_symbolicmap, use_defaults)
+    u0, p = updated_u0_p(
+        prob, u0, p, tspan[1]; interpret_symbolicmap, use_defaults, missing_is_symbolic)
 
     if noise === missing
         noise = prob.noise
@@ -405,8 +417,10 @@ function remake(prob::OptimizationProblem;
         kwargs = missing,
         interpret_symbolicmap = true,
         use_defaults = false,
+        missing_is_symbolic = true,
         _kwargs...)
-    u0, p = updated_u0_p(prob, u0, p; interpret_symbolicmap, use_defaults)
+    u0, p = updated_u0_p(
+        prob, u0, p; interpret_symbolicmap, use_defaults, missing_is_symbolic)
     if f === missing
         f = prob.f
     end
@@ -447,7 +461,6 @@ end
         problem_type = missing, kwargs = missing, _kwargs...)
 
 Remake the given `NonlinearProblem`.
-If `u0` or `p` are given as symbolic maps `ModelingToolkit.jl` has to be loaded.
 """
 function remake(prob::NonlinearProblem;
         f = missing,
@@ -457,8 +470,10 @@ function remake(prob::NonlinearProblem;
         kwargs = missing,
         interpret_symbolicmap = true,
         use_defaults = false,
+        missing_is_symbolic = true,
         _kwargs...)
-    u0, p = updated_u0_p(prob, u0, p; interpret_symbolicmap, use_defaults)
+    u0, p = updated_u0_p(
+        prob, u0, p; interpret_symbolicmap, use_defaults, missing_is_symbolic)
     if f === missing
         f = prob.f
     end
@@ -483,8 +498,9 @@ end
 Remake the given `NonlinearLeastSquaresProblem`.
 """
 function remake(prob::NonlinearLeastSquaresProblem; f = missing, u0 = missing, p = missing,
-        interpret_symbolicmap = true, use_defaults = false, kwargs = missing, _kwargs...)
-    u0, p = updated_u0_p(prob, u0, p; interpret_symbolicmap, use_defaults)
+        interpret_symbolicmap = true, use_defaults = false, missing_is_symbolic = true, kwargs = missing, _kwargs...)
+    u0, p = updated_u0_p(
+        prob, u0, p; interpret_symbolicmap, use_defaults, missing_is_symbolic)
 
     if f === missing
         f = prob.f
@@ -520,31 +536,22 @@ anydict(d) = Dict{Any, Any}(d)
 anydict() = Dict{Any, Any}()
 
 function _updated_u0_p_internal(
-        prob, ::Missing, ::Missing, t0; interpret_symbolicmap = true, use_defaults = false)
+        prob, ::Missing, ::Missing, t0; kwargs...)
     return state_values(prob), parameter_values(prob)
 end
 function _updated_u0_p_internal(
-        prob, ::Missing, p, t0; interpret_symbolicmap = true, use_defaults = false)
-    u0 = state_values(prob)
-
-    if p isa AbstractArray && isempty(p)
-        return _updated_u0_p_internal(
-            prob, u0, parameter_values(prob), t0; interpret_symbolicmap)
-    end
-    eltype(p) <: Pair && interpret_symbolicmap || return u0, p
-    defs = default_values(prob)
-    p = fill_p(prob, anydict(p); defs, use_defaults)
-    return _updated_u0_p_symmap(prob, u0, Val(false), p, Val(true), t0)
+        prob, ::Missing, p, t0; interpret_symbolicmap = true,
+        use_defaults = false, missing_is_symbolic = true)
+    return _updated_u0_p_internal(
+        prob, missing_is_symbolic ? anydict() : state_values(prob), p, t0; interpret_symbolicmap)
 end
 
 function _updated_u0_p_internal(
-        prob, u0, ::Missing, t0; interpret_symbolicmap = true, use_defaults = false)
-    p = parameter_values(prob)
-
-    eltype(u0) <: Pair || return u0, p
-    defs = default_values(prob)
-    u0 = fill_u0(prob, anydict(u0); defs, use_defaults)
-    return _updated_u0_p_symmap(prob, u0, Val(true), p, Val(false), t0)
+        prob, u0, ::Missing, t0; interpret_symbolicmap = true,
+        use_defaults = false, missing_is_symbolic = true)
+    return _updated_u0_p_internal(
+        prob, u0, missing_is_symbolic ? anydict() : parameter_values(prob),
+        t0; interpret_symbolicmap)
 end
 
 function _updated_u0_p_internal(
@@ -725,7 +732,8 @@ function _updated_u0_p_symmap(prob, u0, ::Val{true}, p, ::Val{true}, t0)
 end
 
 function updated_u0_p(
-        prob, u0, p, t0 = nothing; interpret_symbolicmap = true, use_defaults = false)
+        prob, u0, p, t0 = nothing; interpret_symbolicmap = true,
+        use_defaults = false, missing_is_symbolic = true)
     if u0 === missing && p === missing
         return state_values(prob), parameter_values(prob)
     end
@@ -744,7 +752,8 @@ function updated_u0_p(
         return (u0 === missing ? state_values(prob) : u0),
         (p === missing ? parameter_values(prob) : p)
     end
-    return _updated_u0_p_internal(prob, u0, p, t0; interpret_symbolicmap, use_defaults)
+    return _updated_u0_p_internal(
+        prob, u0, p, t0; interpret_symbolicmap, use_defaults, missing_is_symbolic)
 end
 
 # overloaded in MTK to intercept symbolic remake

test/remake_tests.jl

@@ -198,47 +198,54 @@ for prob in deepcopy(probs)
         @test prob2.u0 == u0
         @test prob2.p == typeof(prob.p)(p)
 
-        # Dependency ignored since `p` was not changed
-        prob2 = @inferred baseType remake(prob; u0 = [:x => 0.2])
+        # Dependency ignored since `p` was not changed and `missing_is_symbolic = false`
+        prob2 = @inferred baseType remake(
+            prob; u0 = [:x => 0.2], missing_is_symbolic = false)
         @test prob2.u0 ≈ [0.2, 30.0, 3.0]
         @test prob2.p == typeof(prob.p)(p)
 
-        # need to pass empty `Dict()` to prevent defaulting to existing values
+        # with `missing_is_symbolic = true`
+        prob2 = @inferred baseType remake(
+            prob; u0 = [:x => 0.2])
+        @test prob2.u0 ≈ [0.2, 30.0, 3.0]
+        @test all(prob2.p .≈ [10.0, 0.6, 30.0])
+
+        # above is identical to this
         prob2 = @inferred baseType remake(
             prob; u0 = [:x => 0.2], p = Dict())
         @test prob2.u0 ≈ [0.2, 30.0, 3.0]
         @test all(prob2.p .≈ [10.0, 0.6, 30.0])
 
         prob2 = @inferred baseType remake(
-            prob; u0 = [:x => 0.2], p = Dict(), use_defaults = true)
+            prob; u0 = [:x => 0.2], use_defaults = true)
         @test prob2.u0 ≈ [0.2, 3.0, 3.0]
         @test all(prob2.p .≈ [1.0, 0.6, 30.0])
 
         # override defaults
         prob2 = @inferred baseType remake(
-            prob; u0 = [:y => 0.2], p = Dict())
+            prob; u0 = [:y => 0.2])
         @test prob2.u0 ≈ [1.0, 0.2, 3.0]
         @test all(prob2.p .≈ [10.0, 3.0, 30.0])
         prob2 = @inferred baseType remake(
-            prob; u0 = [:y => 0.2], p = Dict(), use_defaults = true)
+            prob; u0 = [:y => 0.2], use_defaults = true)
         @test prob2.u0 ≈ [0.1, 0.2, 3.0]
         @test all(prob2.p .≈ [1.0, 0.3, 30.0])
 
         prob2 = @inferred baseType remake(
-            prob; p = [:a => 0.2], u0 = Dict())
+            prob; p = [:a => 0.2])
         @test prob2.u0 ≈ [1.0, 0.6, 3.0]
         @test all(prob2.p .≈ [0.2, 3.0, 30.0])
         prob2 = @inferred baseType remake(
-            prob; p = [:a => 0.2], u0 = Dict(), use_defaults = true)
+            prob; p = [:a => 0.2], use_defaults = true)
         @test prob2.u0 ≈ [0.1, 0.6, 3.0]
         @test all(prob2.p .≈ [0.2, 0.3, 30.0])
 
         prob2 = @inferred baseType remake(
-            prob; p = [:b => 0.2], u0 = Dict())
+            prob; p = [:b => 0.2])
         @test prob2.u0 ≈ [1.0, 30.0, 3.0]
         @test all(prob2.p .≈ [10.0, 0.2, 30.0])
         prob2 = @inferred baseType remake(
-            prob; p = [:b => 0.2], u0 = Dict(), use_defaults = true)
+            prob; p = [:b => 0.2], use_defaults = true)
         @test prob2.u0 ≈ [0.1, 3.0, 3.0]
         @test all(prob2.p .≈ [1.0, 0.2, 30.0])