-
-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathparameter_indexing.jl
More file actions
634 lines (580 loc) · 24.1 KB
/
Copy pathparameter_indexing.jl
File metadata and controls
634 lines (580 loc) · 24.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
"""
getp(indp, sym)
Return a function that takes an value provider, and returns the value of the
parameter `sym`. The value provider has to at least store the values of parameters
in the corresponding index provider. Note that `sym` can be an index, symbolic variable,
or an array/tuple of the aforementioned.
If `sym` is an array/tuple of parameters, then the returned function can also be used
as an in-place getter function. The first argument is the buffer (must be an
`AbstractArray`) to which the parameter values should be written, and the second argument
is the value provider.
Requires that the value provider implement [`parameter_values`](@ref). This function
may not always need to be implemented, and has a default implementation for collections
that implement `getindex`.
If the returned function is used on a timeseries object which saves parameter timeseries,
it can be used to index said timeseries. The timeseries object must implement
[`is_parameter_timeseries`](@ref) and [`get_parameter_timeseries_collection`](@ref).
Additionally, the parameter object must implement
[`with_updated_parameter_timeseries_values`](@ref).
If `sym` is a timeseries parameter, the function will return the timeseries of the
parameter if the value provider is a parameter timeseries object. An additional argument
can be provided to the function indicating the specific indexes in the timeseries at
which to access the values. If `sym` is an array of parameters, the following cases
apply:
- All parameters are non-timeseries parameters: The function returns the value of each
parameter.
- All parameters are timeseries parameters: All the parameters must belong to the same
timeseries (otherwise `getp` will error). The function returns the timeseries of all
parameter values, and can be accessed at specific indices in the timeseries.
- A mix of timeseries and non-timeseries parameters: The function can _only_ be used on
non-timeseries objects and will return the value of each parameter at in the object.
"""
function getp(sys, p)
symtype = symbolic_type(p)
elsymtype = symbolic_type(eltype(p))
_getp(sys, symtype, elsymtype, p)
end
struct GetParameterIndex{I} <: AbstractParameterGetIndexer
idx::I
end
is_indexer_timeseries(::Type{GetParameterIndex{I}}) where {I} = IndexerNotTimeseries()
function is_indexer_timeseries(::Type{GetParameterIndex{I}}) where {I <:
ParameterTimeseriesIndex}
IndexerTimeseries()
end
function indexer_timeseries_index(gpi::GetParameterIndex{<:ParameterTimeseriesIndex})
gpi.idx.timeseries_idx
end
function (gpi::GetParameterIndex)(::IsTimeseriesTrait, prob)
parameter_values(prob, gpi.idx)
end
function (gpi::GetParameterIndex)(::Timeseries, prob, args)
throw(ParameterTimeseriesValueIndexMismatchError{Timeseries}(prob, gpi, args))
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(::Timeseries, prob)
get_parameter_timeseries_collection(prob)[gpi.idx]
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
buffer::AbstractArray, ts::Timeseries, prob)
for (buf_idx, ts_idx) in zip(eachindex(buffer),
eachindex(parameter_timeseries(prob, indexer_timeseries_index(gpi))))
buffer[buf_idx] = gpi(ts, prob, ts_idx)
end
return buffer
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
::Timeseries, prob, i::Union{Int, CartesianIndex})
parameter_values(prob, gpi.idx, i)
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(ts::Timeseries, prob, ::Colon)
gpi(ts, prob)
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
buffer::AbstractArray, ts::Timeseries, prob, ::Colon)
gpi(buffer, ts, prob)
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
ts::Timeseries, prob, i::AbstractArray{Bool})
map(only(to_indices(
parameter_timeseries(prob, indexer_timeseries_index(gpi)), (i,)))) do idx
gpi(ts, prob, idx)
end
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
buffer::AbstractArray, ts::Timeseries, prob, i::AbstractArray{Bool})
for (buf_idx, ts_idx) in zip(eachindex(buffer),
only(to_indices(parameter_timeseries(prob, indexer_timeseries_index(gpi)), (i,))))
buffer[buf_idx] = gpi(ts, prob, ts_idx)
end
return buffer
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(ts::Timeseries, prob, i)
gpi.((ts,), (prob,), i)
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
buffer::AbstractArray, ts::Timeseries, prob, i)
for (buf_idx, subidx) in zip(eachindex(buffer), i)
buffer[buf_idx] = gpi(ts, prob, subidx)
end
return buffer
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(::NotTimeseries, prob)
throw(ParameterTimeseriesValueIndexMismatchError{NotTimeseries}(prob, gpi))
end
function (gpi::GetParameterIndex{<:ParameterTimeseriesIndex})(
::AbstractArray, ::NotTimeseries, prob)
throw(ParameterTimeseriesValueIndexMismatchError{NotTimeseries}(prob, gpi))
end
function _getp(sys, ::NotSymbolic, ::NotSymbolic, p)
return GetParameterIndex(p)
end
struct GetParameterTimeseriesIndex{
I <: GetParameterIndex, J <: GetParameterIndex{<:ParameterTimeseriesIndex}} <:
AbstractParameterGetIndexer
param_idx::I
param_timeseries_idx::J
end
is_indexer_timeseries(::Type{G}) where {G <: GetParameterTimeseriesIndex} = IndexerBoth()
function indexer_timeseries_index(gpti::GetParameterTimeseriesIndex)
indexer_timeseries_index(gpti.param_timeseries_idx)
end
as_not_timeseries_indexer(::IndexerBoth, gpti::GetParameterTimeseriesIndex) = gpti.param_idx
function as_timeseries_indexer(::IndexerBoth, gpti::GetParameterTimeseriesIndex)
gpti.param_timeseries_idx
end
function (gpti::GetParameterTimeseriesIndex)(ts::Timeseries, prob, args...)
gpti.param_timeseries_idx(ts, prob, args...)
end
function (gpti::GetParameterTimeseriesIndex)(
buffer::AbstractArray, ts::Timeseries, prob, args...)
gpti.param_timeseries_idx(buffer, ts, prob, args...)
end
function (gpti::GetParameterTimeseriesIndex)(ts::NotTimeseries, prob)
gpti.param_idx(ts, prob)
end
struct GetParameterObserved{I, M, F <: Function} <: AbstractParameterGetIndexer
timeseries_idx::I
obsfn::F
end
function GetParameterObserved{Multiple}(timeseries_idx::I, obsfn::F) where {Multiple, I, F}
if !isa(Multiple, Bool)
throw(TypeError(:GetParameterObserved, "{Multiple}", Bool, Multiple))
end
return GetParameterObserved{I, Multiple, F}(timeseries_idx, obsfn)
end
const MultipleGetParameterObserved = GetParameterObserved{I, true} where {I}
const SingleGetParameterObserved = GetParameterObserved{I, false} where {I}
function is_indexer_timeseries(::Type{G}) where {G <: GetParameterObserved{Nothing}}
IndexerNotTimeseries()
end
is_indexer_timeseries(::Type{G}) where {G <: GetParameterObserved} = IndexerBoth()
indexer_timeseries_index(gpo::GetParameterObserved) = gpo.timeseries_idx
function as_not_timeseries_indexer(
::IndexerBoth, gpo::GetParameterObserved{I, M}) where {I, M}
return GetParameterObserved{M}(nothing, gpo.obsfn)
end
as_timeseries_indexer(::IndexerBoth, gpo::GetParameterObserved) = gpo
function (gpo::GetParameterObserved{Nothing})(::Timeseries, prob)
gpo.obsfn(parameter_values(prob), current_time(prob)[end])
end
for multiple in [true, false]
@eval function (gpo::GetParameterObserved{Nothing, $multiple})(
buffer::AbstractArray, ::Timeseries, prob)
gpo.obsfn(buffer, parameter_values(prob), current_time(prob)[end])
return buffer
end
end
for argType in [Union{Int, CartesianIndex}, Colon, AbstractArray{Bool}, Any]
@eval function (gpo::GetParameterObserved{Nothing})(::Timeseries, prob, args::$argType)
throw(ParameterTimeseriesValueIndexMismatchError{Timeseries}(prob, gpo, args))
end
for multiple in [true, false]
@eval function (gpo::GetParameterObserved{Nothing, $multiple})(
::AbstractArray, ::Timeseries, prob, args::$argType)
throw(ParameterTimeseriesValueIndexMismatchError{Timeseries}(prob, gpo, args))
end
end
end
function (gpo::GetParameterObserved)(::NotTimeseries, prob)
gpo.obsfn(parameter_values(prob), current_time(prob))
end
function (gpo::GetParameterObserved)(buffer::AbstractArray, ::NotTimeseries, prob)
gpo.obsfn(buffer, parameter_values(prob), current_time(prob))
return buffer
end
function (gpo::GetParameterObserved)(::Timeseries, prob)
map(parameter_timeseries(prob, gpo.timeseries_idx)) do t
gpo.obsfn(parameter_values_at_time(prob, t), t)
end
end
function (gpo::MultipleGetParameterObserved)(buffer::AbstractArray, ::Timeseries, prob)
times = parameter_timeseries(prob, gpo.timeseries_idx)
for (buf_idx, time) in zip(eachindex(buffer), times)
gpo.obsfn(buffer[buf_idx], parameter_values_at_time(prob, time), time)
end
return buffer
end
function (gpo::SingleGetParameterObserved)(buffer::AbstractArray, ::Timeseries, prob)
times = parameter_timeseries(prob, gpo.timeseries_idx)
for (buf_idx, time) in zip(eachindex(buffer), times)
buffer[buf_idx] = gpo.obsfn(parameter_values_at_time(prob, time), time)
end
return buffer
end
function (gpo::GetParameterObserved)(::Timeseries, prob, i::Union{Int, CartesianIndex})
time = parameter_timeseries(prob, gpo.timeseries_idx)[i]
gpo.obsfn(parameter_values_at_time(prob, time), time)
end
function (gpo::MultipleGetParameterObserved)(
buffer::AbstractArray, ::Timeseries, prob, i::Union{Int, CartesianIndex})
time = parameter_timeseries(prob, gpo.timeseries_idx)[i]
gpo.obsfn(buffer, parameter_values_at_time(prob, time), time)
end
function (gpo::GetParameterObserved)(ts::Timeseries, prob, ::Colon)
gpo(ts, prob)
end
for gpoType in [MultipleGetParameterObserved, SingleGetParameterObserved]
@eval function (gpo::$gpoType)(buffer::AbstractArray, ts::Timeseries, prob, ::Colon)
gpo(buffer, ts, prob)
end
end
function (gpo::GetParameterObserved)(ts::Timeseries, prob, i::AbstractArray{Bool})
map(only(to_indices(parameter_timeseries(prob, gpo.timeseries_idx), (i,)))) do idx
gpo(ts, prob, idx)
end
end
function (gpo::MultipleGetParameterObserved)(
buffer::AbstractArray, ts::Timeseries, prob, i::AbstractArray{Bool})
for (buf_idx, time_idx) in zip(eachindex(buffer),
only(to_indices(parameter_timeseries(prob, gpo.timeseries_idx), (i,))))
gpo(buffer[buf_idx], ts, prob, time_idx)
end
return buffer
end
function (gpo::SingleGetParameterObserved)(
buffer::AbstractArray, ts::Timeseries, prob, i::AbstractArray{Bool})
for (buf_idx, time_idx) in zip(eachindex(buffer),
only(to_indices(parameter_timeseries(prob, gpo.timeseries_idx), (i,))))
buffer[buf_idx] = gpo(ts, prob, time_idx)
end
return buffer
end
function (gpo::GetParameterObserved)(ts::Timeseries, prob, i)
map(i) do idx
gpo(ts, prob, idx)
end
end
function (gpo::MultipleGetParameterObserved)(buffer::AbstractArray, ts::Timeseries, prob, i)
for (buf_idx, time_idx) in zip(eachindex(buffer), i)
gpo(buffer[buf_idx], ts, prob, time_idx)
end
return buffer
end
function (gpo::SingleGetParameterObserved)(buffer::AbstractArray, ts::Timeseries, prob, i)
for (buf_idx, time_idx) in zip(eachindex(buffer), i)
buffer[buf_idx] = gpo(ts, prob, time_idx)
end
return buffer
end
struct GetParameterObservedNoTime{F <: Function} <: AbstractParameterGetIndexer
obsfn::F
end
function is_indexer_timeseries(::Type{G}) where {G <: GetParameterObservedNoTime}
IndexerNotTimeseries()
end
function (gpo::GetParameterObservedNoTime)(::NotTimeseries, prob)
gpo.obsfn(parameter_values(prob))
end
function (gpo::GetParameterObservedNoTime)(buffer::AbstractArray, ::NotTimeseries, prob)
gpo.obsfn(buffer, parameter_values(prob))
end
function _getp(sys, ::ScalarSymbolic, ::SymbolicTypeTrait, p)
if is_parameter(sys, p)
idx = parameter_index(sys, p)
if is_timeseries_parameter(sys, p)
ts_idx = timeseries_parameter_index(sys, p)
return GetParameterTimeseriesIndex(
GetParameterIndex(idx), GetParameterIndex(ts_idx))
else
return GetParameterIndex(idx)
end
elseif is_observed(sys, p)
pofn = parameter_observed(sys, p)
if pofn === nothing
throw(ArgumentError("Index provider does not support `parameter_observed`; cannot use generate function for $p"))
end
if !is_time_dependent(sys)
return GetParameterObservedNoTime(pofn.observed_fn)
end
return GetParameterObserved{false}(pofn.timeseries_idx, pofn.observed_fn)
end
error("Invalid symbol $p for `getp`")
end
struct MixedTimeseriesIndexes
indexes::Any
end
struct MultipleParametersGetter{T <: IsIndexerTimeseries, G, I} <:
AbstractParameterGetIndexer
getters::G
timeseries_idx::I
end
function MultipleParametersGetter(getters)
has_timeseries_indexers = any(getters) do g
is_indexer_timeseries(g) == IndexerTimeseries()
end
has_non_timeseries_indexers = any(getters) do g
is_indexer_timeseries(g) == IndexerNotTimeseries()
end
if has_timeseries_indexers && has_non_timeseries_indexers
throw(ArgumentError("Cannot mix timeseries and non-timeseries indexers in `$MultipleParametersGetter`"))
end
indexer_type = if has_timeseries_indexers
getters = as_timeseries_indexer.(getters)
timeseries_idx = indexer_timeseries_index(first(getters))
IndexerTimeseries
elseif has_non_timeseries_indexers
getters = as_not_timeseries_indexer.(getters)
timeseries_idx = nothing
IndexerNotTimeseries
else
timeseries_idx = indexer_timeseries_index(first(getters))
IndexerBoth
end
if indexer_type != IndexerNotTimeseries &&
!allequal(indexer_timeseries_index(g) for g in getters)
if indexer_type == IndexerTimeseries
throw(ArgumentError("All parameters must belong to the same timeseries"))
else
indexer_type = IndexerNotTimeseries
timeseries_idx = MixedTimeseriesIndexes(indexer_timeseries_index.(getters))
getters = as_not_timeseries_indexer.(getters)
end
end
return MultipleParametersGetter{indexer_type, typeof(getters), typeof(timeseries_idx)}(
getters, timeseries_idx)
end
const AtLeastTimeseriesMPG = Union{
MultipleParametersGetter{IndexerTimeseries}, MultipleParametersGetter{IndexerBoth}}
const MixedTimeseriesIndexMPG = MultipleParametersGetter{
IndexerNotTimeseries, G, MixedTimeseriesIndexes} where {G}
is_indexer_timeseries(::Type{<:MultipleParametersGetter{T}}) where {T} = T()
function indexer_timeseries_index(mpg::MultipleParametersGetter)
mpg.timeseries_idx
end
function as_not_timeseries_indexer(::IndexerBoth, mpg::MultipleParametersGetter)
MultipleParametersGetter(as_not_timeseries_indexer.(mpg.getters))
end
function as_timeseries_indexer(::IndexerBoth, mpg::MultipleParametersGetter)
MultipleParametersGetter(as_timeseries_indexer.(mpg.getters))
end
for (indexerTimeseriesType, timeseriesType) in [
(IndexerNotTimeseries, IsTimeseriesTrait),
(IndexerBoth, NotTimeseries)
]
@eval function (mpg::MultipleParametersGetter{$indexerTimeseriesType})(
::$timeseriesType, prob)
return _call.(mpg.getters, (prob,))
end
@eval function (mpg::MultipleParametersGetter{$indexerTimeseriesType})(
buffer::AbstractArray, ::$timeseriesType, prob)
for (buf_idx, getter) in zip(eachindex(buffer), mpg.getters)
buffer[buf_idx] = getter(prob)
end
return buffer
end
end
function (mpg::MixedTimeseriesIndexMPG)(::Timeseries, prob, args...)
throw(MixedParameterTimeseriesIndexError(prob, mpg.timeseries_idx.indexes))
end
function (mpg::MultipleParametersGetter{IndexerNotTimeseries})(::Timeseries, prob, args)
throw(ParameterTimeseriesValueIndexMismatchError{Timeseries}(prob, mpg, args))
end
function (mpg::MultipleParametersGetter{IndexerNotTimeseries})(
::AbstractArray, ::Timeseries, prob, args)
throw(ParameterTimeseriesValueIndexMismatchError{Timeseries}(prob, mpg, args))
end
function (mpg::AtLeastTimeseriesMPG)(ts::Timeseries, prob)
map(eachindex(parameter_timeseries(prob, indexer_timeseries_index(mpg)))) do i
mpg(ts, prob, i)
end
end
function (mpg::AtLeastTimeseriesMPG)(::Timeseries, prob, i::Union{Int, CartesianIndex})
CallWith(prob, i).(mpg.getters)
end
function (mpg::AtLeastTimeseriesMPG)(ts::Timeseries, prob, ::Colon)
mpg(ts, prob)
end
function (mpg::AtLeastTimeseriesMPG)(ts::Timeseries, prob, i::AbstractArray{Bool})
map(only(to_indices(
parameter_timeseries(prob, indexer_timeseries_index(mpg)), (i,)))) do idx
mpg(ts, prob, idx)
end
end
function (mpg::AtLeastTimeseriesMPG)(ts::Timeseries, prob, i)
mpg.((ts,), (prob,), i)
end
function (mpg::AtLeastTimeseriesMPG)(buffer::AbstractArray, ts::Timeseries, prob)
for (buf_idx, ts_idx) in zip(eachindex(buffer),
eachindex(parameter_timeseries(prob, indexer_timeseries_index(mpg))))
mpg(buffer[buf_idx], ts, prob, ts_idx)
end
return buffer
end
function (mpg::AtLeastTimeseriesMPG)(
buffer::AbstractArray, ::Timeseries, prob, i::Union{Int, CartesianIndex})
for (buf_idx, getter) in zip(eachindex(buffer), mpg.getters)
buffer[buf_idx] = getter(prob, i)
end
return buffer
end
function (mpg::AtLeastTimeseriesMPG)(buffer::AbstractArray, ts::Timeseries, prob, ::Colon)
mpg(buffer, ts, prob)
end
function (mpg::AtLeastTimeseriesMPG)(
buffer::AbstractArray, ts::Timeseries, prob, i::AbstractArray{Bool})
mpg(buffer, ts, prob,
only(to_indices(parameter_timeseries(prob, indexer_timeseries_index(mpg)), (i,))))
end
function (mpg::AtLeastTimeseriesMPG)(buffer::AbstractArray, ts::Timeseries, prob, i)
for (buf_idx, ts_idx) in zip(eachindex(buffer), i)
mpg(buffer[buf_idx], ts, prob, ts_idx)
end
return buffer
end
function (mpg::MultipleParametersGetter{IndexerTimeseries})(::NotTimeseries, prob)
throw(ParameterTimeseriesValueIndexMismatchError{NotTimeseries}(prob, mpg))
end
function (mpg::MultipleParametersGetter{IndexerTimeseries})(
::AbstractArray, ::NotTimeseries, prob)
throw(ParameterTimeseriesValueIndexMismatchError{NotTimeseries}(prob, mpg))
end
struct AsParameterTupleWrapper{N, G <: AbstractParameterGetIndexer} <:
AbstractParameterGetIndexer
getter::G
end
AsParameterTupleWrapper{N}(getter::G) where {N, G} = AsParameterTupleWrapper{N, G}(getter)
function is_indexer_timeseries(::Type{AsParameterTupleWrapper{N, G}}) where {N, G}
is_indexer_timeseries(G)
end
function indexer_timeseries_index(atw::AsParameterTupleWrapper)
indexer_timeseries_index(atw.getter)
end
function as_timeseries_indexer(::IndexerBoth, atw::AsParameterTupleWrapper{N}) where {N}
AsParameterTupleWrapper{N}(as_timeseries_indexer(atw.getter))
end
function as_not_timeseries_indexer(::IndexerBoth, atw::AsParameterTupleWrapper{N}) where {N}
AsParameterTupleWrapper{N}(as_not_timeseries_indexer(atw.getter))
end
wrap_tuple(::AsParameterTupleWrapper{N}, val) where {N} = ntuple(i -> val[i], Val(N))
function (atw::AsParameterTupleWrapper)(ts::IsTimeseriesTrait, prob, args...)
atw(ts, is_indexer_timeseries(atw), prob, args...)
end
function (atw::AsParameterTupleWrapper)(ts::Timeseries, ::AtLeastTimeseriesIndexer, prob)
wrap_tuple.((atw,), atw.getter(ts, prob))
end
function (atw::AsParameterTupleWrapper)(
ts::Timeseries, ::AtLeastTimeseriesIndexer, prob, i::Union{Int, CartesianIndex})
wrap_tuple(atw, atw.getter(ts, prob, i))
end
function (atw::AsParameterTupleWrapper)(ts::Timeseries, ::AtLeastTimeseriesIndexer, prob, i)
wrap_tuple.((atw,), atw.getter(ts, prob, i))
end
# args is just so it throws
function (atw::AsParameterTupleWrapper)(
ts::Timeseries, ::IndexerNotTimeseries, prob, args...)
wrap_tuple(atw, atw.getter(ts, prob, args...))
end
function (atw::AsParameterTupleWrapper)(
ts::NotTimeseries, ::AtLeastNotTimeseriesIndexer, prob, args...)
wrap_tuple(atw, atw.getter(ts, prob, args...))
end
function (atw::AsParameterTupleWrapper)(
buffer::AbstractArray, ts::IsTimeseriesTrait, prob, args...)
atw.getter(buffer, ts, prob, args...)
end
is_observed_getter(_) = false
is_observed_getter(::GetParameterObserved) = true
is_observed_getter(::GetParameterObservedNoTime) = true
is_observed_getter(mpg::MultipleParametersGetter) = any(is_observed_getter, mpg.getters)
for (t1, t2) in [
(ArraySymbolic, Any),
(ScalarSymbolic, Any),
(NotSymbolic, Union{<:Tuple, <:AbstractArray})
]
@eval function _getp(sys, ::NotSymbolic, ::$t1, p::$t2)
# We need to do it this way because if an `ODESystem` has `p[1], p[2], p[3]` as
# parameters (all scalarized) then `is_observed(sys, p[2:3]) == true`. Then,
# `getp` errors on older MTK that doesn't support `parameter_observed`.
getters = getp.((sys,), p)
num_observed = count(is_observed_getter, getters)
if num_observed == 0
return MultipleParametersGetter(getters)
else
pofn = parameter_observed(sys, p isa Tuple ? collect(p) : p)
if is_time_dependent(sys)
getter = GetParameterObserved{true}(pofn.timeseries_idx, pofn.observed_fn)
else
getter = GetParameterObservedNoTime(pofn.observed_fn)
end
return p isa Tuple ? AsParameterTupleWrapper{length(p)}(getter) : getter
end
end
end
function _getp(sys, ::ArraySymbolic, ::SymbolicTypeTrait, p)
if is_parameter(sys, p)
idx = parameter_index(sys, p)
if is_timeseries_parameter(sys, p)
ts_idx = timeseries_parameter_index(sys, p)
return GetParameterTimeseriesIndex(idx, ts_idx)
else
return GetParameterIndex(idx)
end
end
return getp(sys, collect(p))
end
struct ParameterHookWrapper{S, O} <: AbstractSetIndexer
setter::S
original_index::O
end
function (phw::ParameterHookWrapper)(prob, args...)
res = phw.setter(prob, args...)
finalize_parameters_hook!(prob, phw.original_index)
return res
end
"""
setp(indp, sym)
Return a function that takes an index provider and a value, and sets the parameter `sym`
to that value. Note that `sym` can be an index, a symbolic variable, or an array/tuple of
the aforementioned.
Requires that the value provider implement [`parameter_values`](@ref) and the returned
collection be a mutable reference to the parameter object. In case `parameter_values`
cannot return such a mutable reference, or additional actions need to be performed when
updating parameters, [`set_parameter!`](@ref) must be implemented.
"""
function setp(sys, p; run_hook = true)
symtype = symbolic_type(p)
elsymtype = symbolic_type(eltype(p))
return if run_hook
return ParameterHookWrapper(_setp(sys, symtype, elsymtype, p), p)
else
_setp(sys, symtype, elsymtype, p)
end
end
struct SetParameterIndex{I} <: AbstractSetIndexer
idx::I
end
function (spi::SetParameterIndex)(prob, val)
set_parameter!(prob, val, spi.idx)
end
function _setp(sys, ::NotSymbolic, ::NotSymbolic, p)
return SetParameterIndex(p)
end
function _setp(sys, ::ScalarSymbolic, ::SymbolicTypeTrait, p)
idx = parameter_index(sys, p)
return SetParameterIndex(idx)
end
struct MultipleSetters{S} <: AbstractSetIndexer
setters::S
end
function (ms::MultipleSetters)(prob, val)
broadcast((s!, v) -> s!(prob, v), ms.setters, val)
end
for (t1, t2) in [
(ArraySymbolic, Any),
(ScalarSymbolic, Any),
(NotSymbolic, Union{<:Tuple, <:AbstractArray})
]
@eval function _setp(sys, ::NotSymbolic, ::$t1, p::$t2)
setters = setp.((sys,), p; run_hook = false)
return MultipleSetters(setters)
end
end
function _setp(sys, ::ArraySymbolic, ::SymbolicTypeTrait, p)
if is_parameter(sys, p)
idx = parameter_index(sys, p)
return setp(sys, idx; run_hook = false)
elseif is_observed(sys, p) && (pobsfn = parameter_observed(sys, p)) !== nothing
return GetParameterObserved{false}(pobsfn.timeseries_idx, pobsfn.observed_fn)
end
return setp(sys, collect(p); run_hook = false)
end