Skip to content

begin and end: Indexing Interface for TimestepArrays #695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Jun 15, 2020
Merged

begin and end: Indexing Interface for TimestepArrays #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
923c3eb
Add first and last index interface methods
lrennels Apr 5, 2020
b580897
Work on colon methods
lrennels Apr 5, 2020
4f58a72
Fix syntax bug
lrennels Apr 5, 2020
35dc467
Remove duplicate method
lrennels Apr 5, 2020
3ceb0d0
Fix bugs
lrennels Apr 5, 2020
b73f91f
Add space
lrennels Apr 5, 2020
a746269
Add version check
lrennels Apr 5, 2020
5def56c
Remove extra methods
lrennels Apr 5, 2020
ccf31f6
Add tests
lrennels Apr 5, 2020
9e90cf2
Fix begin and end indexing; add tests
lrennels Apr 6, 2020
f3c15f8
Remove begin tests
lrennels Apr 6, 2020
e92c544
Add tests for begin
lrennels Apr 7, 2020
441bbbf
Update version bounds for testing
lrennels Apr 7, 2020
df9cf27
Try using @static macro
lrennels Apr 9, 2020
72ec253
Merge head
lrennels Apr 9, 2020
20a8ce6
Merge branch 'master' into index-interfaces
lrennels Jun 6, 2020
1b56fe3
Move begin keyword tests to separate file
lrennels Jun 6, 2020
4d8e52c
Fix version test
lrennels Jun 6, 2020
8e0763c
Add static macro
lrennels Jun 6, 2020
95ddb29
Remove begin tests
lrennels Jun 6, 2020
2bea569
Merge branch 'master' into index-interfaces
lrennels Jun 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 53 additions & 3 deletions src/core/time_arrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,59 @@ function _get_ts_indices(ts_array::Array{TimestepValue{T}, 1}, times::Union{Tupl
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
#
Expand Down Expand Up @@ -233,8 +286,6 @@ function Base.length(v::TimestepVector)
return length(v.data)
end

Base.lastindex(v::TimestepVector) = length(v)
Copy link
Collaborator Author

@lrennels lrennels Apr 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this line since it's a duplicate of the new method.


#
# c. TimestepMatrix
#
Expand Down Expand Up @@ -267,7 +318,6 @@ function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP}, T, 2}, id
end

function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 2}, idx::AnyIndex, ts::VariableTimestep{TIMES}) where {T, TIMES}
# WAS THIS: data = mat.data[ts.t, idx, ts.t]
data = mat.data[idx, ts.t]
_missing_data_check(data, ts.t)
end
Expand Down
19 changes: 18 additions & 1 deletion test/test_timesteparrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ idx4 = TimestepIndex(4)

x = TimestepVector{FixedTimestep{2000, 1}, Int}([9, 10, 11, 12])
@test length(x) == 4
@test lastindex(x) == 4
@test lastindex(x) == TimestepIndex(4)

time_dim_val = [9, 10, 11, 12]
temp_dim_val = [100, 101, 102, 103]
Expand Down Expand Up @@ -611,6 +611,23 @@ y_mat = TimestepMatrix{VariableTimestep{y_years}, Int, 1}(time_dim_val[:,:,2])

@test eltype(x_vec) == eltype(y_vec) == eltype(y_vec) == eltype(y_mat) == eltype(time_dim_val)

# TODO begin syntax is depreacated v1.0.0 - v1.3.0, so enable the tests after
# after we disable Julia versions below v1.4.0

# @test x_vec[begin] == time_dim_val[:,1,1][begin]
# @test x_mat[begin,1] == time_dim_val[:,:,1][begin,1]
# @test x_mat[begin,2] == time_dim_val[:,:,1][begin,2]
# @test y_vec[begin] == time_dim_val[:,2,2][begin]
# @test y_mat[begin,1] == time_dim_val[:,:,2][begin,1]
# @test y_mat[begin,2] == time_dim_val[:,:,2][begin,2]

@test x_vec[end] == time_dim_val[:,1,1][end]
@test x_mat[end,1] == time_dim_val[:,:,1][end,1]
@test x_mat[end,2] == time_dim_val[:,:,1][end,2]
@test y_vec[end] == time_dim_val[:,2,2][end]
@test y_mat[end,1] == time_dim_val[:,:,2][end,1]
@test y_mat[end,2] == time_dim_val[:,:,2][end,2]

#------------------------------------------------------------------------------
# 6. Test that getindex for TimestepArrays doesn't allow access to `missing`
# values during `run` that haven't been computed yet.
Expand Down