Skip to content
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.

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

Throw error in getindex function when string and symbol are passed simultaneously #197

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions src/apply.jl
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ julia> show(ts_weekly[1:10])
```
"""
function apply(ts::TSFrame, period::T, fun::V, index_at::Function=first; renamecols::Bool=true) where {T<:Dates.Period, V<:Function}
if !issorted(ts[:, :Index])
throw(ArgumentError("The `Index` column in the TSFrame object is not sorted."))
end

ep = endpoints(ts, period)

j = 1
Expand Down
9 changes: 6 additions & 3 deletions src/diff.jl
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,15 @@ julia> diff(ts, 3)[1:10] # difference over the third row
```
"""

# Diff
# Diff, Here we have used ArgumentError and not DomainError

function diff(ts::TSFrame, periods::Int = 1)
if periods <= 0
error("periods must be a postive int")
#error("periods must be a postive int")
throw(ArgumentError("`periods` must be a postive integer."))
end

ddf = ts.coredata[:, Not(:Index)] .- TSFrames.lag(ts, periods).coredata[:, Not(:Index)]
insertcols!(ddf, 1, "Index" => ts.coredata[:, :Index])
TSFrame(ddf, :Index)
end
end
18 changes: 16 additions & 2 deletions src/endpoints.jl
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,8 @@ julia> datetimesecondsrandom[endpoints(datetimesecondsrandom, Hour(1))]
"""
function endpoints(values::AbstractVector, on::Function, k::Int=1)
if (k <= 0)
throw(DomainError("`k` needs to be greater than 0"))
# throw(DomainError("`k` needs to be greater than 0"))
throw(ArgumentError("`k` must be a postive integer."))
end

ex = Expr(:call, on, values)
Expand All @@ -304,7 +305,20 @@ function endpoints(ts::TSFrame, on::Function, k::Int=1)
endpoints(index(ts), on, k)
end

function endpoints(timestamps::AbstractVector{T}, on::V)::Vector{Int} where {T<:Union{Date, DateTime, Time}, V<:Dates.Period}
function endpoints(timestamps::AbstractVector{T}, on::V)::Vector{Int} where {T<:Union{Date, DateTime, Time},
V<:Union{
Year,
Quarter,
Month,
Week,
Day,
Hour,
Minute,
Second,
Millisecond,
Microsecond,
Nanosecond
}}
if (on.value <= 0)
throw(DomainError("`on.value` needs to be greater than 0"))
end
Expand Down
84 changes: 64 additions & 20 deletions src/getindex.jl
Original file line number Diff line number Diff line change
Expand Up @@ -252,11 +252,12 @@ julia> ts[1, "x1"]; # same as above
###

### Inputs: row scalar, column scalar; Output: scalar

Copy link
Member

Choose a reason for hiding this comment

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

Can you remove the extra line here?

function Base.getindex(ts::TSFrame, i::Int, j::Int)
return ts.coredata[i,j+1]
end

function Base.getindex(ts::TSFrame, i::Int, j::Union{Symbol, String})
function Base.getindex(ts::TSFrame, i::Int, j::Union{Symbol, AbstractString})
chiraganand marked this conversation as resolved.
Show resolved Hide resolved
return ts.coredata[i, j]
end

Expand All @@ -265,29 +266,40 @@ function Base.getindex(ts::TSFrame, dt::T, j::Int) where {T<:TimeType}
ts.coredata[idx, j+1]
end

function Base.getindex(ts::TSFrame, dt::T, j::Union{String, Symbol}) where {T<:TimeType}
function Base.getindex(ts::TSFrame, dt::T, j::Union{AbstractString, Symbol}) where {T<:TimeType}
chiraganand marked this conversation as resolved.
Show resolved Hide resolved
idx = findfirst(x -> x == dt, index(ts))
ts.coredata[idx, j]
end
###

### Inputs: row scalar, column vector; Output: TSFrame
function Base.getindex(ts::TSFrame, i::Int, j::AbstractVector{Int})
TSFrame(ts.coredata[[i], Cols(:Index, j.+1)]) # increment: account for Index
TSFrame(ts.coredata[[i], Cols(:Index, j.+1)]) # increment: account for Index
Copy link
Member

Choose a reason for hiding this comment

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

There is only whitespace difference in this line. Can you remove this change too?

end

function Base.getindex(ts::TSFrame, i::Int, j::AbstractVector{T}) where {T<:Union{String, Symbol}}
TSFrame(ts.coredata[[i], Cols(:Index, j)])

function Base.getindex(ts::TSFrame, i::Int, j::AbstractVector{T}) where {T<:Union{AbstractString, Symbol}}
if length(unique(map(x -> typeof(x), j))) == 1
TSFrame(ts.coredata[[i], Cols(:Index, j)])
else
throw(ArgumentError("The column vector cannot contain both String and Symbol types."))
end
end


Copy link
Member

Choose a reason for hiding this comment

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

Empty line.

function Base.getindex(ts::TSFrame, dt::T, j::AbstractVector{Int}) where {T<:TimeType}
idx = findfirst(x -> x == dt, index(ts))
ts[idx, j]
end

function Base.getindex(ts::TSFrame, dt::D, j::AbstractVector{T}) where {D<:TimeType, T<:Union{String, Symbol}}
function Base.getindex(ts::TSFrame, dt::D, j::AbstractVector{T}) where {D<:TimeType, T<:Union{AbstractString, Symbol}}
idx = findfirst(x -> x == dt, index(ts))
ts[idx, j]
if length(unique(map(x -> typeof(x), j))) == 1
ts[idx, j]
else
throw(ArgumentError("The column vector cannot contain both AbstractString and Symbol types."))
end

end
###

Expand All @@ -302,7 +314,8 @@ function Base.getindex(ts::TSFrame, i::AbstractVector{Int}, j::Int)
ts.coredata[i, j+1] # increment: account for Index
end

function Base.getindex(ts::TSFrame, i::AbstractVector{Int}, j::Union{String, Symbol})

Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

function Base.getindex(ts::TSFrame, i::AbstractVector{Int}, j::Union{AbstractString, Symbol})
Copy link
Member

Choose a reason for hiding this comment

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

Check is needed here.

ts.coredata[i, j]
end

Expand All @@ -314,12 +327,18 @@ function Base.getindex(ts::TSFrame, dt::AbstractVector{T}, j::Int) where {T<:Tim
ts[idx, j]
end

function Base.getindex(ts::TSFrame, dt::AbstractVector{T}, j::Union{String, Symbol}) where {T<:TimeType}

function Base.getindex(ts::TSFrame, dt::AbstractVector{T}, j::Union{AbstractString, Symbol}) where {T<:TimeType}
idx = map(d -> findfirst(x -> x == d, index(ts)), dt)
if length(idx) == 0
return nothing
else
if length(unique(map(x -> typeof(x), j))) == 1
Copy link
Member

Choose a reason for hiding this comment

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

This check should happen before idx = map(d -> ...).

ts[idx, j]
else
throw(ArgumentError("The column vector cannot contain both AbstractString and Symbol types."))
end
end
ts[idx, j]
end
###

Expand All @@ -328,10 +347,16 @@ function Base.getindex(ts::TSFrame, i::AbstractVector{Int}, j::AbstractVector{In
TSFrame(ts.coredata[i, Cols(:Index, j.+1)]) # increment: account for Index
end

function Base.getindex(ts::TSFrame, i::AbstractVector{Int}, j::AbstractVector{T}) where {T<:Union{String, Symbol}}
TSFrame(ts.coredata[i, Cols(:Index, j)])

Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

function Base.getindex(ts::TSFrame, i::AbstractVector{Int}, j::AbstractVector{T}) where {T<:Union{AbstractString, Symbol}}
if length(unique(map(x -> typeof(x), j))) == 1
TSFrame(ts.coredata[i, Cols(:Index, j)])
else
throw(ArgumentError("The column vector cannot contain both AbstractString and Symbol types."))
end
end


Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

function Base.getindex(ts::TSFrame, dt::AbstractVector{T}, j::AbstractVector{Int}) where {T<:TimeType}
idx = map(d -> findfirst(x -> x == d, index(ts)), dt)
if length(idx) == 0
Expand All @@ -340,9 +365,15 @@ function Base.getindex(ts::TSFrame, dt::AbstractVector{T}, j::AbstractVector{Int
ts[idx, j]
end

function Base.getindex(ts::TSFrame, dt::AbstractVector{D}, j::AbstractVector{T}) where {D<:TimeType, T<:Union{String, Symbol}}

Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

function Base.getindex(ts::TSFrame, dt::AbstractVector{D}, j::AbstractVector{T}) where {D<:TimeType, T<:Union{AbstractString, Symbol}}
idx = map(d -> findfirst(x -> x == d, index(ts)), dt)
ts[idx, j]
if length(unique(map(x -> typeof(x), j))) == 1
Copy link
Member

Choose a reason for hiding this comment

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

The check should happen before idx = map(d -> ....

ts[idx, j]
else
throw(ArgumentError("The column vector cannot contain both AbstractString and Symbol types."))
end

end
###

Expand All @@ -362,7 +393,8 @@ function Base.getindex(ts::TSFrame, i::UnitRange, j::Int)
ts[collect(i), j]
end

function Base.getindex(ts::TSFrame, i::UnitRange, j::Union{String, Symbol})

Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

function Base.getindex(ts::TSFrame, i::UnitRange, j::Union{AbstractString, Symbol})
ts[collect(i), j]
end
###
Expand All @@ -372,8 +404,14 @@ function Base.getindex(ts::TSFrame, i::UnitRange, j::AbstractVector{Int})
ts[collect(i), j]
end

function Base.getindex(ts::TSFrame, i::UnitRange, j::AbstractVector{T}) where {T<:Union{String, Symbol}}
ts[collect(i), j]

function Base.getindex(ts::TSFrame, i::UnitRange, j::AbstractVector{T}) where {T<:Union{AbstractString, Symbol}}
if length(unique(map(x -> typeof(x), j))) == 1
ts[collect(i), j]
else
throw(ArgumentError("The column vector cannot contain both AbstractString and Symbol types."))
end

end
###

Expand Down Expand Up @@ -476,7 +514,8 @@ function Base.getindex(ts::TSFrame, ::Colon, j::Int)
ts[1:TSFrames.nrow(ts), j]
end

function Base.getindex(ts::TSFrame, ::Colon, j::Union{String, Symbol})

Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

function Base.getindex(ts::TSFrame, ::Colon, j::Union{AbstractString, Symbol})
ts[1:TSFrames.nrow(ts), j]
end
###
Expand All @@ -486,8 +525,13 @@ function Base.getindex(ts::TSFrame, ::Colon, j::AbstractVector{Int})
ts[1:TSFrames.nrow(ts), j]
end

function Base.getindex(ts::TSFrame, ::Colon, j::AbstractVector{T}) where {T<:Union{String, Symbol}}
ts[1:TSFrames.nrow(ts), j]
function Base.getindex(ts::TSFrame, ::Colon, j::AbstractVector{T}) where {T<:Union{AbstractString, Symbol}}
if length(unique(map(x -> typeof(x), j))) == 1
ts[1:TSFrames.nrow(ts), j]
else
throw(ArgumentError("The column vector cannot contain both AbstractString and Symbol types."))
end

Copy link
Member

Choose a reason for hiding this comment

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

Extra line.

end
###

Expand Down
3 changes: 2 additions & 1 deletion src/subset.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
subset(ts::TSFrame, from::T, to::T) where {T<:Union{Int, TimeType}}
```

Create a subset of `ts` based on the `Index` starting `from`
Create a subset of `ts` based on the [`Index`](@ref) starting `from`
(inclusive) till `to` (inclusive).

# Examples
Expand Down Expand Up @@ -139,6 +139,7 @@ julia> subset(ts,Date("2022-9-27"),:)

"""
function subset(ts::TSFrame, from::T, to::T) where {T<:Union{Int, TimeType}}
#TSFrame(DataFrames.subset(ts.coredata, :Index => x -> from .<= x .<= to))
TSFrame(DataFrames.subset(ts.coredata, :Index => x -> from .<= x .<= to))
end

Expand Down
1 change: 1 addition & 0 deletions src/utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,7 @@ function _check_consistency(ts::TSFrame)::Bool
issorted(index(ts))
end


"""

```julia
Expand Down
Loading