Skip to content

WIP: Allow Indexing into a Variable/Parameter with a Year #551

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

Closed
wants to merge 3 commits into from
Closed

WIP: Allow Indexing into a Variable/Parameter with a Year #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63c35f6
add Timestep type and start getindex methods
lrennels Sep 19, 2019
11beadc
Add methods and fix bugs
lrennels Sep 19, 2019
b10b69d
Fix how we treat offsets, simplify functions
lrennels Sep 20, 2019
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
70 changes: 70 additions & 0 deletions src/core/time.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,14 @@ function Base.:+(ts::VariableTimestep{TIMES}, val::Int) where {TIMES}
new_ts = VariableTimestep{TIMES}(ts.t + val)
end

function Base.:-(ts::Timestep, val::Int)
return Timestep(ts.value, ts.offset_in_timesteps - val)
end

function Base.:+(ts::Timestep, val::Int)
return Timestep(ts.value, ts.offset_in_timesteps + val)
end

#
# 2. CLOCK
#
Expand Down Expand Up @@ -195,6 +203,20 @@ function _missing_data_check(data)
end
end

# Helper functions for Timestep type
function _get_time_value_position_(times::Array, ts::Timestep)
t = findfirst(isequal.(ts.value, times))
if t === nothing
error("cannot use Timestep with value $(ts.value), value is not in the TimestepArray")
end

t_offset = t + ts.offset_in_timesteps
if t_offset > length(times)
error("cannot get offset of $(ts.offset_in_timesteps) from $(ts.value), offset is after the end of the TimestepArray")
end
return t_offset
end

# Helper macro used by connector
macro allow_missing(expr)
let e = gensym("e")
Expand Down Expand Up @@ -239,6 +261,18 @@ function Base.getindex(v::TimestepVector{VariableTimestep{D_TIMES}, T}, ts::Vari
_missing_data_check(data)
end

function Base.getindex(v::TimestepVector{FixedTimestep{FIRST, STEP, LAST}, T}, ts::Timestep) where {T, FIRST, STEP, LAST}
t = _get_time_value_position_([FIRST:STEP:LAST...], ts)
data = v.data[t]
_missing_data_check(data)
end

function Base.getindex(v::TimestepVector{VariableTimestep{TIMES}, T}, ts::Timestep) where {T, TIMES}
t = _get_time_value_position_(TIMES, ts)
data = v.data[t]
_missing_data_check(data)
end

# int indexing version supports old-style components and internal functions, not
# part of the public API

Expand Down Expand Up @@ -333,6 +367,30 @@ function Base.getindex(mat::TimestepMatrix{VariableTimestep{D_TIMES}, T, 2}, idx
_missing_data_check(data)
end

function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP, LAST}, T, 1}, ts::Timestep, idx::AnyIndex) where {T, FIRST, STEP, LAST}
t = _get_time_value_position_([FIRST:STEP:LAST...], ts)
data = mat.data[t, idx]
_missing_data_check(data)
end

function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 1}, ts::Timestep, idx::AnyIndex) where {T, TIMES}
t = _get_time_value_position_(TIMES, ts)
data = mat.data[t, idx]
_missing_data_check(data)
end

function Base.getindex(mat::TimestepMatrix{FixedTimestep{FIRST, STEP, LAST}, T, 2}, idx::AnyIndex, ts::Timestep) where {T, FIRST, STEP, LAST}
t = _get_time_value_position_([FIRST:STEP:LAST...], ts)
data = mat.data[idx, t]
_missing_data_check(data)
end

function Base.getindex(mat::TimestepMatrix{VariableTimestep{TIMES}, T, 2}, idx::AnyIndex, ts::Timestep) where {T, TIMES}
t = _get_time_value_position_(TIMES, ts)
data = mat.data[idx, t]
_missing_data_check(data)
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)
Expand Down Expand Up @@ -449,6 +507,18 @@ function Base.getindex(arr::TimestepArray{VariableTimestep{D_TIMES}, T, N, ti},
return arr.data[idxs1..., t, idxs2...]
end

function Base.getindex(arr::TimestepArray{FixedTimestep{FIRST, STEP, LAST}, T, N, ti}, idxs::Union{Timestep, AnyIndex}...) where {T, N, ti, FIRST, STEP, LAST}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = _get_time_value_position_([FIRST:STEP:LAST...], ts)
return arr.data[idxs1..., t, idxs2...]
end

function Base.getindex(arr::TimestepArray{VariableTimestep{TIMES}, T, N, ti}, idxs::Union{Timestep, AnyIndex}...) where {T, N, ti, TIMES}
idxs1, ts, idxs2 = split_indices(idxs, ti)
t = _get_time_value_position_(TIMES, ts)
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...)
Expand Down
9 changes: 9 additions & 0 deletions src/core/types.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ struct VariableTimestep{TIMES} <: AbstractTimestep
end
end

struct Timestep <: AbstractTimestep
value::Int
offset_in_timesteps::Int

function Timestep(v::Int, offset_in_timesteps::Int=0)
return new(v, offset_in_timesteps)
end
end

mutable struct Clock{T <: AbstractTimestep}
ts::T

Expand Down