Merge pull request #970 from vyudu/resid

add `resid_prototype` to ImplicitDiscreteFunction

Author: ChrisRackauckas

src/scimlfunctions.jl

@@ -948,7 +948,8 @@ dt: the time step
 
 ```julia
 ImplicitDiscreteFunction{iip,specialize}(f;
-                                analytic = __has_analytic(f) ? f.analytic : nothing)
+                                analytic = __has_analytic(f) ? f.analytic : nothing, 
+                                resid_prototype = __has_resid_prototype(f) ? f.resid_prototype : nothing)
 ```
 
 Note that only the function `f` itself is required. This function should
@@ -973,12 +974,13 @@ For more details on this argument, see the ODEFunction documentation.
 
 The fields of the ImplicitDiscreteFunction type directly match the names of the inputs.
 """
-struct ImplicitDiscreteFunction{iip, specialize, F, Ta, O, SYS, ID} <:
+struct ImplicitDiscreteFunction{iip, specialize, F, Ta, O, SYS, RP, ID} <:
        AbstractDiscreteFunction{iip}
     f::F
     analytic::Ta
     observed::O
     sys::SYS
+    resid_prototype::RP
     initialization_data::ID
 end
 
@@ -3064,6 +3066,9 @@ function ImplicitDiscreteFunction{iip, specialize}(f;
         observed = __has_observed(f) ?
                    f.observed :
                    DEFAULT_OBSERVED,
+        resid_prototype = __has_resid_prototype(f) ?
+                          f.resid_prototype : 
+                          nothing,
         sys = __has_sys(f) ? f.sys : nothing,
         initialization_data = __has_initialization_data(f) ? f.initialization_data :
                               nothing) where {
@@ -3074,39 +3079,40 @@ function ImplicitDiscreteFunction{iip, specialize}(f;
     sys = sys_or_symbolcache(sys, syms, paramsyms, indepsym)
 
     if specialize === NoSpecialize
-        ImplicitDiscreteFunction{iip, specialize, Any, Any, Any, Any, Any}(_f,
+        ImplicitDiscreteFunction{iip, specialize, Any, Any, Any, Any, Any, Any}(_f,
             analytic,
             observed,
             sys,
+            resid_prototype, 
             initialization_data)
     else
         ImplicitDiscreteFunction{
-            iip, specialize, typeof(_f), typeof(analytic), typeof(observed), typeof(sys),
+                                 iip, specialize, typeof(_f), typeof(analytic), typeof(observed), typeof(sys), typeof(resid_prototype),
             typeof(initialization_data)}(
-            _f, analytic, observed, sys, initialization_data)
+            _f, analytic, observed, sys, resid_prototype, initialization_data)
     end
 end
 
 function ImplicitDiscreteFunction{iip}(f; kwargs...) where {iip}
     ImplicitDiscreteFunction{iip, FullSpecialize}(f; kwargs...)
 end
 ImplicitDiscreteFunction{iip}(f::ImplicitDiscreteFunction; kwargs...) where {iip} = f
-function ImplicitDiscreteFunction(f; kwargs...)
-    ImplicitDiscreteFunction{isinplace(f, 5), FullSpecialize}(f; kwargs...)
+function ImplicitDiscreteFunction(f; resid_prototype = __has_resid_prototype(f) ? f.resid_prototype : nothing, kwargs...)
+    ImplicitDiscreteFunction{isinplace(f, 5), FullSpecialize}(f; resid_prototype, kwargs...)
 end
 ImplicitDiscreteFunction(f::ImplicitDiscreteFunction; kwargs...) = f
 
 function unwrapped_f(f::ImplicitDiscreteFunction, newf = unwrapped_f(f.f))
     specialize = specialization(f)
 
     if specialize === NoSpecialize
-        ImplicitDiscreteFunction{isinplace(f, 6), specialize, Any, Any,
-            Any, Any, Any}(newf, f.analytic, f.observed, f.sys, f.initialization_data)
+        ImplicitDiscreteFunction{isinplace(f, 5), specialize, Any, Any, Any,
+            Any, Any, Any}(newf, f.analytic, f.observed, f.sys, f.resid_prototype, f.initialization_data)
     else
-        ImplicitDiscreteFunction{isinplace(f, 6), specialize, typeof(newf),
+        ImplicitDiscreteFunction{isinplace(f, 5), specialize, typeof(newf),
             typeof(f.analytic),
-            typeof(f.observed), typeof(f.sys), typeof(f.initialization_data)}(newf,
-            f.analytic, f.observed, f.sys, f.initialization_data)
+            typeof(f.observed), typeof(f.sys), typeof(resid_prototype), typeof(f.initialization_data)}(newf,
+            f.analytic, f.observed, f.sys, f.resid_prototype, f.initialization_data)
     end
 end