Merge pull request #62 from SciML/as/remake-buffer

feat: add `remake_buffer`

Author: ChrisRackauckas

Project.toml

@@ -4,21 +4,27 @@ authors = ["Aayush Sabharwal <[email protected]> and contributors"]
 version = "0.3.11"
 
 [deps]
+ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 RuntimeGeneratedFunctions = "7e49a35a-f44a-4d26-94aa-eba1b4ca6b47"
+StaticArraysCore = "1e83bf80-4336-4d27-bf5d-d5a4f845583c"
 
 [compat]
 Aqua = "0.8"
+ArrayInterface = "7.9"
 MacroTools = "0.5.13"
 RuntimeGeneratedFunctions = "0.5"
 SafeTestsets = "0.0.1"
+StaticArrays = "1.9"
+StaticArraysCore = "1.4"
 Test = "1"
 julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Aqua", "Test", "SafeTestsets"]
+test = ["Aqua", "Test", "SafeTestsets", "StaticArrays"]

docs/src/api.md

@@ -53,6 +53,12 @@ getu
 setu
 ```
 
+## Container objects
+
+```@docs
+remake_buffer
+```
+
 ### Parameter timeseries
 
 If a solution object saves a timeseries of parameter values that are updated during the

docs/src/complete_sii.md

@@ -452,3 +452,9 @@ idxs = @show rand(Bool, 10) # boolean mask for indexing
 sol.ps[:a, idxs]
 ```
 
+## Custom containers
+
+A custom container object (such as `ModelingToolkit.MTKParameters`) should implement
+[`remake_buffer`](@ref) to allow creating a new buffer with updated values, possibly
+with different types. This is already implemented for `AbstractArray`s (including static
+arrays).

docs/src/usage.md

@@ -182,3 +182,13 @@ parameter_values(prob)
     on other problem/solution instances can be the key to achieving good performance. Note
     that this caching is allowed only when the symbolic system is unchanged (it's fine for
     the numerical values to have changed, but not the underlying equations).
+
+## Re-creating a buffer
+
+To re-create a buffer (of unknowns or parameters) use [`remake_buffer`](@ref). This allows
+changing the type of values in the buffer (for example, changing the value of a parameter
+from `Float64` to `Float32`).
+
+```@example Usage
+remake_buffer(sys, prob.p, Dict(σ => 1f0, ρ => 2f0, β => 3f0))
+```

src/SymbolicIndexingInterface.jl

@@ -2,6 +2,9 @@ module SymbolicIndexingInterface
 
 import MacroTools
 using RuntimeGeneratedFunctions
+import StaticArraysCore: MArray, similar_type
+import ArrayInterface
+
 RuntimeGeneratedFunctions.init(@__MODULE__)
 
 export ScalarSymbolic, ArraySymbolic, NotSymbolic, symbolic_type, hasname, getname,
@@ -28,4 +31,7 @@ include("state_indexing.jl")
 
 export ParameterIndexingProxy
 include("parameter_indexing_proxy.jl")
+
+export remake_buffer
+include("remake.jl")
 end

src/remake.jl

@@ -0,0 +1,32 @@
+"""
+    remake_buffer(sys, oldbuffer, vals::Dict)
+
+Return a copy of the buffer `oldbuffer` with values from `vals`. The keys of `vals`
+are symbolic variables whose index in the buffer is determined using `sys`. The types of
+values in `vals` may not match the types of values stored at the corresponding indexes in
+the buffer, in which case the type of the buffer should be promoted accordingly. In
+general, this method should attempt to preserve the types of values stored in `vals` as
+much as possible. The returned buffer should be of the same type (ignoring type-parameters)
+as `oldbuffer`.
+
+This method is already implemented for
+`remake_buffer(sys, oldbuffer::AbstractArray, vals::Dict)` and supports static arrays
+as well.
+"""
+function remake_buffer(sys, oldbuffer::AbstractArray, vals::Dict)
+    # similar when used with an `MArray` and nonconcrete eltype returns a
+    # SizedArray. `similar_type` still returns an `MArray`
+    if ArrayInterface.ismutable(oldbuffer) && !isa(oldbuffer, MArray)
+        elT = Union{}
+        for val in values(vals)
+            elT = Union{elT, typeof(val)}
+        end
+
+        newbuffer = similar(oldbuffer, elT)
+        setu(sys, keys(vals))(newbuffer, values(vals))
+    else
+        mutbuffer = remake_buffer(sys, collect(oldbuffer), vals)
+        newbuffer = similar_type(oldbuffer, eltype(mutbuffer))(mutbuffer)
+    end
+    return newbuffer
+end

test/remake_test.jl

@@ -0,0 +1,40 @@
+using SymbolicIndexingInterface
+using StaticArrays
+
+sys = SymbolCache([:x, :y, :z], [:a, :b, :c], :t)
+
+for (buf, newbuf, newvals) in [
+                               # standard operation
+                               ([1.0, 2.0, 3.0], [2.0, 3.0, 4.0],
+                                   Dict(:x => 2.0, :y => 3.0, :z => 4.0))
+                               # type "demotion"
+                               ([1.0, 2.0, 3.0], [2, 3, 4],
+                                   Dict(:x => 2, :y => 3, :z => 4))
+                               # type promotion
+                               ([1, 2, 3], [2.0, 3.0, 4.0],
+                                   Dict(:x => 2.0, :y => 3.0, :z => 4.0))
+                               # union
+                               ([1, 2, 3], Union{Int, Float64}[2, 3.0, 4.0],
+                                   Dict(:x => 2, :y => 3.0, :z => 4.0))
+                               # standard operation
+                               ([1.0, 2.0, 3.0], [2.0, 3.0, 4.0],
+                                   Dict(:a => 2.0, :b => 3.0, :c => 4.0))
+                               # type "demotion"
+                               ([1.0, 2.0, 3.0], [2, 3, 4],
+                                   Dict(:a => 2, :b => 3, :c => 4))
+                               # type promotion
+                               ([1, 2, 3], [2.0, 3.0, 4.0],
+                                   Dict(:a => 2.0, :b => 3.0, :c => 4.0))
+                               # union
+                               ([1, 2, 3], Union{Int, Float64}[2, 3.0, 4.0],
+                                   Dict(:a => 2, :b => 3.0, :c => 4.0))]
+    for arrType in [Vector, SVector{3}, MVector{3}, SizedVector{3}]
+        buf = arrType(buf)
+        newbuf = arrType(newbuf)
+        _newbuf = remake_buffer(sys, buf, newvals)
+
+        @test _newbuf != buf # should not alias
+        @test newbuf == _newbuf # test values
+        @test typeof(newbuf) == typeof(_newbuf) # ensure appropriate type
+    end
+end

test/runtests.jl

@@ -23,3 +23,6 @@ end
 @safetestset "State indexing test" begin
     @time include("state_indexing_test.jl")
 end
+@safetestset "Remake test" begin
+    @time include("remake_test.jl")
+end