-
Notifications
You must be signed in to change notification settings - Fork 34
/
time_arrays.jl
707 lines (580 loc) · 28.4 KB
/
time_arrays.jl
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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
#
# TimestepVector and TimestepMatrix
#
#
# a. General
#
# Get a timestep array of type T with N dimensions. Time labels will match those from the time dimension in md
function get_timestep_array(md::ModelDef, T, N, ti, value)
if isuniform(md)
first, stepsize = first_and_step(md)
first === nothing && @warn "get_timestep_array: first === nothing"
return TimestepArray{FixedTimestep{first, stepsize}, T, N, ti}(value)
else
TIMES = (time_labels(md)...,)
return TimestepArray{VariableTimestep{TIMES}, T, N, ti}(value)
end
end
# Return the index position of the time dimension in the datumdef or parameter. If there is no time dimension, return nothing
get_time_index_position(dims::Union{Nothing, Array{Symbol}}) = findfirst(isequal(:time), dims)
get_time_index_position(obj::Union{AbstractDatumDef, ArrayModelParameter}) = get_time_index_position(dim_names(obj))
function get_time_index_position(obj::AbstractCompositeComponentDef, comp_name::Symbol, datum_name::Symbol)
get_time_index_position(dim_names(compdef(obj, comp_name), datum_name))
end
const AnyIndex = Union{Int, Vector{Int}, Tuple, Colon, OrdinalRange}
# DEPRECATION - EVENTUALLY REMOVE
const AnyIndex_NonColon = Union{Int, Vector{Int}, Tuple, OrdinalRange}
# Helper function for getindex; throws a MissingException if data is missing, otherwise returns data
function _missing_data_check(data, t)
if data === missing
throw(MissingException("Cannot get index; data is missing. You may have tried to access a value in timestep $t that has not yet been computed."))
else
return data
end
end
# Helper function for getindex; throws an error if the TimestepIndex index is out of range of the TimestepArray
function _index_bounds_check(data, dim, t)
if size(data, dim) < t
error("TimestepIndex index $t extends beyond bounds of TimestepArray dimension $dim")
end
end
# Helper function for getindex; throws an error if you index into a N-dimensional TimestepArray with only one index
# if N > 1; Note that Julia does allow this and returns the column-major value, but this could produce unexpected
# behavior for users in this case so we do not allow it for now
function _single_index_check(data, idxs)
num_idxs = length(idxs)
num_dims = length(size(data))
if num_idxs < num_dims
error("Not enough indices provided to index into TimestepArray, $num_idxs provided, $num_dims required")
end
end
# DEPRECATION - EVENTUALLY REMOVE
# Helper function for getindex; throws an error if one indexes into a TimestepArray with an integer
function _throw_int_getindex_error()
error("Indexing with getindex into a TimestepArray with Integer(s) is deprecated, please index with a TimestepIndex(index::Int) instead ie. instead of t[2] use t[TimestepIndex(2)]")
end
# DEPRECATION - EVENTUALLY REMOVE
# Helper function for setindex; throws an error if one indexes into a TimestepArray with an integer
function _throw_int_setindex_error()
error("Indexing with setindex into a TimestepArray with Integer(s) is deprecated, please index with a TimestepIndex(index::Int) instead ie. instead of t[2] use t[TimestepIndex(2)]")
end
# Helper macro used by connector
macro allow_missing(expr)
let e = gensym("e")
retexpr = quote
try
$expr
catch $e
if $e isa MissingException
missing
else
rethrow($e)
end
end
end
return esc(retexpr)
end
end
# Helper functions for TimestepValue type
function _get_time_value_position(times::Union{Tuple, Array}, ts::TimestepValue{T}) where T
t = findfirst(isequal.(ts.value, times))
if t === nothing
error("cannot use TimestepValue with value $(ts.value), value is not in the TimestepArray")
end
t_offset = t + ts.offset
if t_offset > length(times)
error("cannot get TimestepValue offset of $(ts.offset) from value $(ts.value), offset is after the end of the TimestepArray")
end
return t_offset
end
# Helper function to get the array of indices from an Array{TimestepIndex,1}
function _get_ts_indices(ts_array::Array{TimestepIndex, 1})
return [ts.index for ts in ts_array]
end
function _get_ts_indices(ts_array::Array{TimestepValue{T}, 1}, times::Union{Tuple, Array}) where T
return [_get_time_value_position(times, ts) for ts in ts_array]
end
# Base.firstindex and Base.lastindex
function Base.firstindex(arr::TimestepArray{T_TS, T, N, ti}) where {T_TS, T, N, ti}
if ti == 1
return Mimi.TimestepIndex(1)
else
return 1
end
end
function Base.lastindex(arr::TimestepArray{T_TS, T, N, ti}) where {T_TS, T, N, ti}
if ti == length(size(arr.data))
return Mimi.TimestepIndex(length(arr.data))
else
return length(arr.data)
end
end
function Base.lastindex(arr::TimestepArray{T_TS, T, N, ti}, dim::Int) where {T_TS, T, N, ti}
if ti == dim
return Mimi.TimestepIndex(size(arr.data, dim))
else
return size(arr.data, dim)
end
end
function Base.firstindex(arr::TimestepArray{T_TS, T, N, ti}, dim::Int) where {T_TS, T, N, ti}
if ti == dim
return Mimi.TimestepIndex(1)
else
return 1
end
end
# add axes methos copied from abstarctarray.jl:56
function Base.axes(A::TimestepArray{T_TS, T, N, ti}, d::Int) where {T_TS, T, N, ti}
_d_lessthan_N = d <= N;
if d == ti
if _d_lessthan_N
return Tuple(TimestepIndex.(1:size(A,d)))
else
return TimestepIndex(1)
end
else
if _d_lessthan_N
if _d_lessthan_N
return 1:size(A,d)
else
return 1
end
end
end
end
#
# b. TimestepVector
#
function Base.getindex(v::TimestepVector{FixedTimestep{FIRST, STEP}, T}, ts::FixedTimestep{FIRST, STEP, LAST}) where {T, FIRST, STEP, LAST}
data = v.data[ts.t]
_missing_data_check(data, ts.t)
end
function Base.getindex(v::TimestepVector{VariableTimestep{TIMES}, T}, ts::VariableTimestep{TIMES}) where {T, TIMES}
data = v.data[ts.t]
_missing_data_check(data, ts.t)
end
function Base.getindex(v::TimestepVector{FixedTimestep{D_FIRST, STEP}, T}, ts::FixedTimestep{T_FIRST, STEP, LAST}) where {T, D_FIRST, T_FIRST, STEP, LAST}
t = Int(ts.t + (T_FIRST - D_FIRST) / STEP)
data = v.data[t]
_missing_data_check(data, t)
end
function Base.getindex(v::TimestepVector{VariableTimestep{D_TIMES}, T}, ts::VariableTimestep{T_TIMES}) where {T, D_TIMES, T_TIMES}
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
data = v.data[t]
_missing_data_check(data, t)
end
function Base.getindex(v::TimestepVector{FixedTimestep{FIRST, STEP}, T_data}, ts::TimestepValue{T_time}) where {T_data, FIRST, STEP, T_time}
LAST = FIRST + ((length(v.data)-1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
data = v.data[t]
_missing_data_check(data, t)
end
function Base.getindex(v::TimestepVector{VariableTimestep{TIMES}, T_data}, ts::TimestepValue{T_time}) where {T_data, TIMES, T_time}
t = _get_time_value_position(TIMES, ts)
data = v.data[t]
_missing_data_check(data, t)
end
function Base.getindex(v::TimestepVector, ts::TimestepIndex)
t = ts.index
_index_bounds_check(v.data, 1, t)
data = v.data[t]
_missing_data_check(data, t)
end
function Base.setindex!(v::TimestepVector{FixedTimestep{FIRST, STEP}, T}, val, ts::FixedTimestep{FIRST, STEP, LAST}) where {T, FIRST, STEP, LAST}
setindex!(v.data, val, ts.t)
end
function Base.setindex!(v::TimestepVector{VariableTimestep{TIMES}, T}, val, ts::VariableTimestep{TIMES}) where {T, TIMES}
setindex!(v.data, val, ts.t)
end
function Base.setindex!(v::TimestepVector{FixedTimestep{D_FIRST, STEP}, T}, val, ts::FixedTimestep{T_FIRST, STEP, LAST}) where {T, D_FIRST, T_FIRST, STEP, LAST}
t = Int(ts.t + (T_FIRST - D_FIRST) / STEP)
setindex!(v.data, val, t)
end
function Base.setindex!(v::TimestepVector{VariableTimestep{D_TIMES}, T}, val, ts::VariableTimestep{T_TIMES}) where {T, D_TIMES, T_TIMES}
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
setindex!(v.data, val, t)
end
function Base.setindex!(v::TimestepVector{FixedTimestep{FIRST, STEP}, T_data}, val, ts::TimestepValue{T_time}) where {T_data, FIRST, STEP, T_time}
LAST = FIRST + ((length(v.data)-1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
setindex!(v.data, val, t)
end
function Base.setindex!(v::TimestepVector{VariableTimestep{TIMES}, T_data}, val, ts::TimestepValue{T_time}) where {T_data, TIMES, T_time}
t = _get_time_value_position(TIMES, ts)
setindex!(v.data, val, t)
end
function Base.setindex!(v::TimestepVector, val, ts::TimestepIndex)
setindex!(v.data, val, ts.index)
end
# DEPRECATION - EVENTUALLY REMOVE
# int indexing version supports old-style components and internal functions, not
# part of the public API
function Base.getindex(v::TimestepVector{FixedTimestep{FIRST, STEP}, T}, i::AnyIndex_NonColon) where {T, FIRST, STEP}
_throw_int_getindex_error()
end
function Base.getindex(v::TimestepVector{VariableTimestep{TIMES}, T}, i::AnyIndex_NonColon) where {T, TIMES}
_throw_int_getindex_error()
end
function Base.setindex!(v::TimestepVector{FixedTimestep{Start, STEP}, T}, val, i::AnyIndex_NonColon) where {T, Start, STEP}
_throw_int_setindex_error()
end
function Base.setindex!(v::TimestepVector{VariableTimestep{TIMES}, T}, val, i::AnyIndex_NonColon) where {T, TIMES}
_throw_int_setindex_error()
end
function Base.length(v::TimestepVector)
return length(v.data)
end
#
# c. TimestepMatrix
#
function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, 1}, ts::FixedTimestep{FIRST, STEP, LAST}, idx::AnyIndex) where {T, FIRST, STEP, LAST}
data = mat.data[ts.t, idx]
_missing_data_check(data, ts.t)
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 1}, ts::VariableTimestep{TIMES}, idx::AnyIndex) where {T, TIMES}
data = mat.data[ts.t, idx]
_missing_data_check(data, ts.t)
end
function Base.getindex(mat::TimestepMatrix{FixedTimestep{D_FIRST, STEP}, T, 1}, ts::FixedTimestep{T_FIRST, STEP, LAST}, idx::AnyIndex) where {T, D_FIRST, T_FIRST, STEP, LAST}
t = Int(ts.t + (T_FIRST - D_FIRST) / STEP)
data = mat.data[t, idx]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{D_TIMES}, T, 1}, ts::VariableTimestep{T_TIMES}, idx::AnyIndex) where {T, D_TIMES, T_TIMES}
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
data = mat.data[t, idx]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, 2}, idx::AnyIndex, ts::FixedTimestep{FIRST, STEP, LAST}) where {T, FIRST, STEP, LAST}
data = mat.data[idx, ts.t]
_missing_data_check(data, ts.t)
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 2}, idx::AnyIndex, ts::VariableTimestep{TIMES}) where {T, TIMES}
data = mat.data[idx, ts.t]
_missing_data_check(data, ts.t)
end
function Base.getindex(mat::TimestepMatrix{FixedTimestep{D_FIRST, STEP}, T, 2}, idx::AnyIndex, ts::FixedTimestep{T_FIRST, STEP, LAST}) where {T, D_FIRST, T_FIRST, STEP, LAST}
t = Int(ts.t + (T_FIRST - D_FIRST) / STEP)
data = mat.data[idx, t]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{D_TIMES}, T, 2}, idx::AnyIndex, ts::VariableTimestep{T_TIMES}) where {T, D_TIMES, T_TIMES}
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
data = mat.data[idx, t]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T_data, 1}, ts::TimestepValue{T_time}, idx::AnyIndex) where {T_data, FIRST, STEP, T_time}
LAST = FIRST + ((size(mat.data, 1) - 1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
data = mat.data[t, idx]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T_data, 1}, ts::TimestepValue{T_time}, idx::AnyIndex) where {T_data, TIMES, T_time}
t = _get_time_value_position(TIMES, ts)
data = mat.data[t, idx]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix, ts::TimestepIndex, idx::AnyIndex)
t = ts.index
_index_bounds_check(mat.data, 1, t)
data = mat.data[t, idx]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T_data, 2}, idx::AnyIndex, ts::TimestepValue{T_time}) where {T_data, FIRST, STEP, T_time}
LAST = FIRST + ((size(mat.data, 2) - 1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
data = mat.data[idx, t]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T_data, 2}, idx::AnyIndex, ts::TimestepValue{T_time}) where {T_data, TIMES, T_time}
t = _get_time_value_position(TIMES, ts)
data = mat.data[idx, t]
_missing_data_check(data, t)
end
function Base.getindex(mat::TimestepMatrix, idx::AnyIndex, ts::TimestepIndex)
t = ts.index
_index_bounds_check(mat.data, 2, t)
data = mat.data[idx, t]
_missing_data_check(data, t)
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, 1}, val, ts::FixedTimestep{FIRST, STEP, LAST}, idx::AnyIndex) where {T, FIRST, STEP, LAST}
setindex!(mat.data, val, ts.t, idx)
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 1}, val, ts::VariableTimestep{TIMES}, idx::AnyIndex) where {T, TIMES}
setindex!(mat.data, val, ts.t, idx)
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{D_FIRST, STEP}, T, 1}, val, ts::FixedTimestep{T_FIRST, STEP, LAST}, idx::AnyIndex) where {T, D_FIRST, T_FIRST, STEP, LAST}
t = Int(ts.t + (T_FIRST - D_FIRST) / STEP)
setindex!(mat.data, val, t, idx)
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{D_TIMES}, T, 1}, val, ts::VariableTimestep{T_TIMES}, idx::AnyIndex) where {T, D_TIMES, T_TIMES}
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
setindex!(mat.data, val, t, idx)
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, 2}, val, idx::AnyIndex, ts::FixedTimestep{FIRST, STEP, LAST}) where {T, FIRST, STEP, LAST}
setindex!(mat.data, val, idx, ts.t)
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 2}, val, idx::AnyIndex, ts::VariableTimestep{TIMES}) where {T, TIMES}
setindex!(mat.data, val, idx, ts.t)
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{D_FIRST, STEP}, T, 2}, val, idx::AnyIndex, ts::FixedTimestep{T_FIRST, STEP, LAST}) where {T, D_FIRST, T_FIRST, STEP, LAST}
t = Int(ts.t + (T_FIRST - D_FIRST) / STEP)
setindex!(mat.data, val, idx, t)
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{D_TIMES}, T, 2}, val, idx::AnyIndex, ts::VariableTimestep{T_TIMES}) where {T, D_TIMES, T_TIMES}
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
setindex!(mat.data, val, idx, t)
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T_data, 1}, val, ts::TimestepValue{T_time}, idx::AnyIndex) where {T_data, FIRST, STEP, T_time}
LAST = FIRST + ((size(mat.data, 1) - 1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
setindex!(mat.data, val, t, idx)
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{TIMES}, T_data, 1}, val, ts::TimestepValue{T_time}, idx::AnyIndex) where {T_data, TIMES, T_time}
t = _get_time_value_position(TIMES, ts)
setindex!(mat.data, val, t, idx)
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T_data, 2}, val, idx::AnyIndex, ts::TimestepValue{T_time}) where {T_data, FIRST, STEP, T_time}
LAST = FIRST + ((size(mat.data, 1) - 1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
setindex!(mat.data, val, idx, t)
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{TIMES}, T_data, 2}, val, idx::AnyIndex, ts::TimestepValue{T_time}) where {T_data, TIMES, T_time}
t = _get_time_value_position(TIMES, ts)
setindex!(mat.data, val, idx, t)
end
function Base.setindex!(mat::TimestepMatrix, val, idx::AnyIndex, ts::TimestepIndex)
setindex!(mat.data, val, idx, ts.index)
end
function Base.setindex!(mat::TimestepMatrix, val, ts::TimestepIndex, idx::AnyIndex)
setindex!(mat.data, val, ts.index, idx)
end
# DEPRECATION - EVENTUALLY REMOVE
# int indexing version supports old-style components and internal functions, not
# part of the public API
function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, ti}, idx1::AnyIndex_NonColon, idx2::AnyIndex_NonColon) where {T, FIRST, STEP, ti}
_throw_int_getindex_error()
end
function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T, ti}, idx1::AnyIndex_NonColon, idx2::AnyIndex_NonColon) where {T, TIMES, ti}
_throw_int_getindex_error()
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, ti}, val, idx1::Int, idx2::Int) where {T, FIRST, STEP, ti}
_throw_int_setindex_error()
end
function Base.setindex!(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, ti}, val, idx1::AnyIndex_NonColon, idx2::AnyIndex_NonColon) where {T, FIRST, STEP, ti}
_throw_int_setindex_error()
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{TIMES}, T, ti}, val, idx1::Int, idx2::Int) where {T, TIMES, ti}
_throw_int_setindex_error()
end
function Base.setindex!(mat::TimestepMatrix{VariableTimestep{TIMES}, T, ti}, val, idx1::AnyIndex_NonColon, idx2::AnyIndex_NonColon) where {T, TIMES, ti}
_throw_int_setindex_error()
end
#
# TimestepArray methods
#
# _dotview_helper TODOs - we should add options for if the arg is a TimestepValue
# or an array of TimestepIndexes or TimestepValues
function _dotview_helper(arg)
if arg isa AbstractTimestep
return arg.t
elseif arg isa TimestepIndex
return arg.index
else
return arg
end
end
function Base.dotview(v::Mimi.TimestepArray, args...)
# convert any timesteps to their underlying index
args = map(_dotview_helper, args)
Base.dotview(v.data, args...)
end
Base.fill!(obj::TimestepArray, value) = fill!(obj.data, value)
Base.size(obj::TimestepArray) = size(obj.data)
Base.size(obj::TimestepArray, i::Int) = size(obj.data, i)
Base.ndims(obj::TimestepArray{T_ts, T, N, ti}) where {T_ts, T, N, ti} = N
Base.eltype(obj::TimestepArray{T_ts, T, N, ti}) where {T_ts, T, N, ti} = T
first_period(obj::TimestepArray{FixedTimestep{FIRST,STEP}, T, N, ti}) where {FIRST, STEP, T, N, ti} = FIRST
first_period(obj::TimestepArray{VariableTimestep{TIMES}, T, N, ti}) where {TIMES, T, N, ti} = TIMES[1]
last_period(obj::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}) where {FIRST, STEP, T, N, ti} = (FIRST + (size(obj, 1) - 1) * STEP)
last_period(obj::TimestepArray{VariableTimestep{TIMES}, T, N, ti}) where {TIMES, T, N, ti} = TIMES[end]
time_labels(obj::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}) where {FIRST, STEP, T, N, ti} = collect(FIRST:STEP:(FIRST + (size(obj, 1) - 1) * STEP))
time_labels(obj::TimestepArray{VariableTimestep{TIMES}, T, N, ti}) where {TIMES, T, N, ti} = collect(TIMES)
split_indices(idxs, ti) = idxs[1:ti - 1], idxs[ti], idxs[ti + 1:end]
function Base.getindex(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, idxs::Union{FixedTimestep{FIRST, STEP, LAST}, AnyIndex}...) where {T, N, ti, FIRST, STEP, LAST}
idxs1, ts, idxs2 = split_indices(idxs, ti)
return arr.data[idxs1..., ts.t, idxs2...]
end
function Base.getindex(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, idxs::Union{VariableTimestep{TIMES}, AnyIndex}...) where {T, N, ti, TIMES}
idxs1, ts, idxs2 = split_indices(idxs, ti)
return arr.data[idxs1..., ts.t, idxs2...]
end
function Base.getindex(arr::TimestepArray{FixedTimestep{D_FIRST, STEP}, T, N, ti}, idxs::Union{FixedTimestep{T_FIRST, STEP, LAST}, AnyIndex}...) where {T, N, ti, D_FIRST, T_FIRST, STEP, LAST}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = Int(ts.t + (FIRST - TIMES[1]) / STEP)
return arr.data[idxs1..., t, idxs2...]
end
function Base.getindex(arr::TimestepArray{VariableTimestep{D_TIMES}, T, N, ti}, idxs::Union{VariableTimestep{T_TIMES}, AnyIndex}...) where {T, N, ti, D_TIMES, T_TIMES}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.t + findfirst(isequal(T_TIMES[1]), D_TIMES) - 1
return arr.data[idxs1..., t, idxs2...]
end
function Base.getindex(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T_data, N, ti}, idxs::Union{TimestepValue{T_time}, AnyIndex}...) where {T_data, N, ti, FIRST, STEP, T_time}
_single_index_check(arr.data, idxs)
idxs1, ts, idxs2 = split_indices(idxs, ti)
LAST = FIRST + ((size(arr.data, ti) - 1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
return arr.data[idxs1..., t, idxs2...]
end
function Base.getindex(arr::TimestepArray{VariableTimestep{TIMES}, T_data, N, ti}, idxs::Union{TimestepValue{T_time}, AnyIndex}...) where {T_data, N, ti, TIMES, T_time}
_single_index_check(arr.data, idxs)
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = _get_time_value_position(TIMES, ts)
return arr.data[idxs1..., t, idxs2...]
end
function Base.getindex(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, idxs::Union{TimestepIndex, AnyIndex}...) where {T, N, ti, FIRST, STEP}
_single_index_check(arr.data, idxs)
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.index
_index_bounds_check(arr.data, ti, t)
return arr.data[idxs1..., t, idxs2...]
end
function Base.getindex(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, idxs::Union{TimestepIndex, AnyIndex}...) where {T, N, ti, TIMES}
_single_index_check(arr.data, idxs)
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.index
_index_bounds_check(arr.data, ti, t)
return arr.data[idxs1..., t, idxs2...]
end
function Base.setindex!(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, val, idxs::Union{FixedTimestep{FIRST, STEP, LAST}, AnyIndex}...) where {T, N, ti, FIRST, STEP, LAST}
idxs1, ts, idxs2 = split_indices(idxs, ti)
setindex!(arr.data, val, idxs1..., ts.t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, val, idxs::Union{VariableTimestep{TIMES}, AnyIndex}...) where {T, N, ti, TIMES}
idxs1, ts, idxs2 = split_indices(idxs, ti)
setindex!(arr.data, val, idxs1..., ts.t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{FixedTimestep{D_FIRST, STEP}, T, N, ti}, val, idxs::Union{FixedTimestep{T_FIRST, STEP, LAST}, AnyIndex}...) where {T, N, ti, D_FIRST, T_FIRST, STEP, LAST}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.t + findfirst(isequal(T_FIRST[1]), D_FIRST) - 1
setindex!(arr.data, val, idxs1..., t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{VariableTimestep{D_TIMES}, T, N, ti}, val, idxs::Union{VariableTimestep{T_TIMES}, AnyIndex}...) where {T, N, ti, D_TIMES, T_TIMES}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.t + findfirst(isequal(T_FIRST[1]), T_TIMES) - 1
setindex!(arr.data, val, idxs1..., t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T_data, N, ti}, val, idxs::Union{TimestepValue{T_time}, AnyIndex}...) where {T_data, N, ti, FIRST, STEP, T_time}
_single_index_check(arr.data, idxs)
idxs1, ts, idxs2 = split_indices(idxs, ti)
LAST = FIRST + ((size(arr.data, ti) - 1) * STEP)
t = _get_time_value_position([FIRST:STEP:LAST...], ts)
setindex!(arr.data, val, idxs1..., t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{VariableTimestep{TIMES}, T_data, N, ti}, val, idxs::Union{TimestepValue{T_time}, AnyIndex}...) where {T_data, N, ti, TIMES, T_time}
_single_index_check(arr.data, idxs)
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = _get_time_value_position(TIMES, ts)
setindex!(arr.data, val, idxs1..., t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, val, idxs::Union{TimestepIndex, AnyIndex}...) where {T, N, ti, FIRST, STEP}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.index
setindex!(arr.data, val, idxs1..., t, idxs2...)
end
function Base.setindex!(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, val, idxs::Union{TimestepIndex, AnyIndex}...) where {T, N, ti, TIMES}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = ts.index
setindex!(arr.data, val, idxs1..., t, idxs2...)
end
# DEPRECATION - EVENTUALLY REMOVE
# Colon support - this allows the time dimension to be indexed with a colon
function Base.getindex(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, idxs::AnyIndex...) where {FIRST, STEP, T, N, ti}
isa(idxs[ti], AnyIndex_NonColon) ? _throw_int_getindex_error() : nothing
return arr.data[idxs...]
end
function Base.getindex(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, idxs::AnyIndex...) where {TIMES, T, N, ti}
isa(idxs[ti], AnyIndex_NonColon) ? _throw_int_getindex_error() : nothing
return arr.data[idxs...]
end
function Base.setindex!(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, val, idxs::AnyIndex...) where {FIRST, STEP, T, N, ti}
isa(idxs[ti], AnyIndex_NonColon) ? _throw_int_setindex_error() : nothing
setindex!(arr.data, val, idxs...)
end
function Base.setindex!(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, val, idxs::AnyIndex...) where {TIMES, T, N, ti}
isa(idxs[ti], AnyIndex_NonColon) ? _throw_int_setindex_error() : nothing
setindex!(arr.data, val, idxs...)
end
# Indexing with arrays of TimestepIndexes or TimestepValues
function Base.getindex(arr::TimestepArray{TS, T, N, ti}, idxs::Union{Array{TimestepIndex,1}, AnyIndex}...) where {TS, T, N, ti}
idxs1, ts_array, idxs2 = split_indices(idxs, ti)
ts_idxs = _get_ts_indices(ts_array)
return arr.data[idxs1..., ts_idxs, idxs2...]
end
function Base.getindex(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T_data, N, ti}, idxs::Union{Array{TimestepValue{T_time},1}, AnyIndex}...) where {T_data, N, ti, FIRST, STEP, T_time}
idxs1, ts_array, idxs2 = split_indices(idxs, ti)
LAST = FIRST + ((length(arr.data)-1) * STEP)
ts_idxs = _get_ts_indices(ts_array, [FIRST:STEP:LAST...])
return arr.data[idxs1..., ts_idxs, idxs2...]
end
function Base.getindex(arr::TimestepArray{VariableTimestep{TIMES}, T_data, N, ti}, idxs::Union{Array{TimestepValue{T_times},1}, AnyIndex}...) where {T_data, N, ti, TIMES, T_times}
idxs1, ts_array, idxs2 = split_indices(idxs, ti)
ts_idxs = _get_ts_indices(ts_array, TIMES)
return arr.data[idxs1..., ts_idxs, idxs2...]
end
function Base.setindex!(arr::TimestepArray{TS, T, N, ti}, vals, idxs::Union{Array{TimestepIndex,1}, AnyIndex}...) where {TS, T, N, ti}
idxs1, ts_array, idxs2 = split_indices(idxs, ti)
ts_idxs = _get_ts_indices(ts_array)
setindex!(arr.data, vals, idxs1..., ts_idxs, idxs2...)
end
function Base.setindex!(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T_data, N, ti}, vals, idxs::Union{Array{TimestepValue{T_times},1}, AnyIndex}...) where {T_data, N, ti, FIRST, STEP, T_times}
idxs1, ts_array, idxs2 = split_indices(idxs, ti)
LAST = FIRST + ((length(arr.data)-1) * STEP)
ts_idxs = _get_ts_indices(ts_array, [FIRST:STEP:LAST...])
setindex!(arr.data, vals, idxs1..., ts_idxs, idxs2...)
end
function Base.setindex!(arr::TimestepArray{VariableTimestep{TIMES}, T_data, N, ti}, vals, idxs::Union{Array{TimestepValue{T_times},1}, AnyIndex}...) where {T_data, N, ti, TIMES, T_times}
idxs1, ts_array, idxs2 = split_indices(idxs, ti)
ts_idxs = _get_ts_indices(ts_array, TIMES)
setindex!(arr.data, vals, idxs1..., ts_idxs, idxs2...)
end
"""
hasvalue(arr::TimestepArray, ts::FixedTimestep)
Return `true` or `false`, `true` if the TimestepArray `arr` contains the Timestep `ts`.
"""
function hasvalue(arr::TimestepArray{FixedTimestep{FIRST, STEP}, T, N, ti}, ts::FixedTimestep{FIRST, STEP, LAST}) where {T, N, ti, FIRST, STEP, LAST}
return 1 <= ts.t <= size(arr, 1)
end
"""
hasvalue(arr::TimestepArray, ts::VariableTimestep)
Return `true` or `false`, `true` if the TimestepArray `arr` contains the Timestep `ts`.
"""
function hasvalue(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, ts::VariableTimestep{TIMES}) where {T, N, ti, TIMES}
return 1 <= ts.t <= size(arr, 1)
end
function hasvalue(arr::TimestepArray{FixedTimestep{D_FIRST, STEP}, T, N, ti}, ts::FixedTimestep{T_FIRST, STEP, LAST}) where {T, N, ti, D_FIRST, T_FIRST, STEP, LAST}
return D_FIRST <= gettime(ts) <= last_period(arr)
end
function hasvalue(arr::TimestepArray{VariableTimestep{D_FIRST}, T, N, ti}, ts::VariableTimestep{T_FIRST}) where {T, N, ti, T_FIRST, D_FIRST}
return D_FIRST[1] <= gettime(ts) <= last_period(arr)
end
"""
hasvalue(arr::TimestepArray, ts::FixedTimestep, idxs::Int...)
Return `true` or `false`, `true` if the TimestepArray `arr` contains the Timestep `ts` within
indices `idxs`. Used when Array and Timestep have different FIRST, validating all dimensions.
"""
function hasvalue(arr::TimestepArray{FixedTimestep{D_FIRST, STEP}, T, N, ti},
ts::FixedTimestep{T_FIRST, STEP, LAST},
idxs::Int...) where {T, N, ti, D_FIRST, T_FIRST, STEP, LAST}
return D_FIRST <= gettime(ts) <= last_period(arr) && all([1 <= idx <= size(arr, i) for (i, idx) in enumerate(idxs)])
end
"""
hasvalue(arr::TimestepArray, ts::VariableTimestep, idxs::Int...)
Return `true` or `false`, `true` if the TimestepArray `arr` contains the Timestep `ts` within
indices `idxs`. Used when Array and Timestep different TIMES, validating all dimensions.
"""
function hasvalue(arr::TimestepArray{VariableTimestep{D_FIRST}, T, N, ti},
ts::VariableTimestep{T_FIRST},
idxs::Int...) where {T, N, ti, D_FIRST, T_FIRST}
return D_FIRST[1] <= gettime(ts) <= last_period(arr) && all([1 <= idx <= size(arr, i) for (i, idx) in enumerate(idxs)])
end