feat: implement remake_buffer for Tuples

Author: AayushSabharwal

Project.toml

@@ -4,12 +4,14 @@ authors = ["Aayush Sabharwal <aayush.sabharwal@gmail.com> and contributors"]
 version = "0.3.13"
 
 [deps]
+Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
 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]
+Accessors = "0.1.36"
 Aqua = "0.8"
 ArrayInterface = "7.9"
 MacroTools = "0.5.13"

src/SymbolicIndexingInterface.jl

@@ -4,6 +4,7 @@ import MacroTools
 using RuntimeGeneratedFunctions
 import StaticArraysCore: MArray, similar_type
 import ArrayInterface
+using Accessors: @reset
 
 RuntimeGeneratedFunctions.init(@__MODULE__)
 

src/remake.jl

@@ -30,3 +30,19 @@ function remake_buffer(sys, oldbuffer::AbstractArray, vals::Dict)
     end
     return newbuffer
 end
+
+mutable struct TupleRemakeWrapper
+    t::Tuple
+end
+
+function set_parameter!(sys::TupleRemakeWrapper, val, idx)
+    tp = sys.t
+    @reset tp[idx] = val
+    sys.t = tp
+end
+
+function remake_buffer(sys, oldbuffer::Tuple, vals::Dict)
+    wrap = TupleRemakeWrapper(oldbuffer)
+    setu(sys, collect(keys(vals)))(wrap, values(vals))
+    return wrap.t
+end

test/remake_test.jl

@@ -4,30 +4,23 @@ 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))
-                               # buffer type "demotion"
-                               ([1.0, 2.0, 3.0], [2, 3, 4],
-                                   Dict(:x => 2, :y => 3, :z => 4))
-                               # buffer type promotion
-                               ([1, 2, 3], [2.0, 3.0, 4.0],
-                                   Dict(:x => 2.0, :y => 3.0, :z => 4.0))
-                               # value type promotion
-                               ([1, 2, 3], [2.0, 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))
-                               # buffer type "demotion"
-                               ([1.0, 2.0, 3.0], [2, 3, 4],
-                                   Dict(:a => 2, :b => 3, :c => 4))
-                               # buffer type promotion
-                               ([1, 2, 3], [2.0, 3.0, 4.0],
-                                   Dict(:a => 2.0, :b => 3.0, :c => 4.0))
-                               # value type promotion
-                               ([1, 2, 3], [2, 3.0, 4.0],
-                                   Dict(:a => 2, :b => 3.0, :c => 4.0))]
+    # standard operation
+    ([1.0, 2.0, 3.0], [2.0, 3.0, 4.0], Dict(:x => 2.0, :y => 3.0, :z => 4.0)),
+    # buffer type "demotion"
+    ([1.0, 2.0, 3.0], [2, 3, 4], Dict(:x => 2, :y => 3, :z => 4)),
+    # buffer type promotion
+    ([1, 2, 3], [2.0, 3.0, 4.0], Dict(:x => 2.0, :y => 3.0, :z => 4.0)),
+    # value type promotion
+    ([1, 2, 3], [2.0, 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)),
+    # buffer type "demotion"
+    ([1.0, 2.0, 3.0], [2, 3, 4], Dict(:a => 2, :b => 3, :c => 4)),
+    # buffer type promotion
+    ([1, 2, 3], [2.0, 3.0, 4.0], Dict(:a => 2.0, :b => 3.0, :c => 4.0)),
+    # value type promotion
+    ([1, 2, 3], [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)
@@ -38,3 +31,19 @@ for (buf, newbuf, newvals) in [
         @test typeof(newbuf) == typeof(_newbuf) # ensure appropriate type
     end
 end
+
+# Tuples not allowed for state
+for (buf, newbuf, newvals) in [
+    # standard operation
+    ((1.0, 2.0, 3.0), (2.0, 3.0, 4.0), Dict(:a => 2.0, :b => 3.0, :c => 4.0)),
+    # buffer type "demotion"
+    ((1.0, 2.0, 3.0), (2, 3, 4), Dict(:a => 2, :b => 3, :c => 4)),
+    # buffer type promotion
+    ((1, 2, 3), (2.0, 3.0, 4.0), Dict(:a => 2.0, :b => 3.0, :c => 4.0)),
+    # value type promotion
+    ((1, 2, 3), (2, 3.0, 4.0), Dict(:a => 2, :b => 3.0, :c => 4.0))
+]
+    _newbuf = remake_buffer(sys, buf, newvals)
+    @test newbuf == _newbuf # test values
+    @test typeof(newbuf) == typeof(_newbuf) # ensure appropriate type
+end