Skip to content

OffsetArray constructor accepts Integer offsets instead of only Int ones #188

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 1 commit into from
Jan 15, 2021
Merged

OffsetArray constructor accepts Integer offsets instead of only Int ones #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions src/OffsetArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ struct OffsetArray{T,N,AA<:AbstractArray{T,N}} <: AbstractArray{T,N}
end
end

function OffsetArray{T, N, AA}(parent::AA, offsets::NTuple{N, <:Integer}) where {T, N, AA<:AbstractArray{T,N}}
OffsetArray{T, N, AA}(parent, map(x -> convert(Int, x), offsets))
end

"""
OffsetVector(v, index)

Expand All @@ -133,8 +137,8 @@ const OffsetMatrix{T,AA<:AbstractMatrix{T}} = OffsetArray{T,2,AA}

function overflow_check(r, offset::T) where T
# This gives some performance boost https://github.com/JuliaLang/julia/issues/33273
throw_upper_overflow_error() = throw(ArgumentError("Boundary overflow detected: offset $offset should be equal or less than $(typemax(T) - last(r))"))
throw_lower_overflow_error() = throw(ArgumentError("Boundary overflow detected: offset $offset should be equal or greater than $(typemin(T) - first(r))"))
throw_upper_overflow_error() = throw(OverflowError("Boundary overflow detected: offset should be <= $(typemax(T) - last(r)) for offsets of type $T, received $offset"))
throw_lower_overflow_error() = throw(OverflowError("Boundary overflow detected: offset should be >= $(typemin(T) - first(r)) for offsets of type $T, received $offset"))

if offset > 0 && last(r) > typemax(T) - offset
throw_upper_overflow_error()
Expand Down
24 changes: 17 additions & 7 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ end
one_based_axes = Any[
(Base.OneTo(4), ),
(1:4, ),
(big(1):big(4), ),
(CartesianIndex(1):CartesianIndex(4), ),
(IdentityUnitRange(1:4), ),
(IdOffsetRange(1:4),),
Expand All @@ -209,13 +210,17 @@ end

offset_axes = Any[
(-1:2, ),
(big(-1):big(2), ),
(CartesianIndex(-1):CartesianIndex(2), ),
(IdentityUnitRange(-1:2), ),
(IdOffsetRange(-1:2),),
(IdOffsetRange(3:6, -4),)
]

for inds in Any[size.(one_based_axes[1], 1), one_based_axes...]
offsets = size.(one_based_axes[1], 1)
offsets_big = map(big, offsets)

for inds in Any[offsets, offsets_big, one_based_axes...]
# test indices API
a = OffsetVector{Float64}(undef, inds)
@test eltype(a) === Float64
Expand Down Expand Up @@ -294,11 +299,11 @@ end
# overflow bounds check
v = rand(5)
@test axes(OffsetVector(v, typemax(Int)-length(v))) == (IdOffsetRange(axes(v)[1], typemax(Int)-length(v)), )
@test_throws ArgumentError OffsetVector(v, typemax(Int)-length(v)+1)
@test_throws OverflowError OffsetVector(v, typemax(Int)-length(v)+1)
ao = OffsetArray(v, typemin(Int))
@test_nowarn OffsetArray{Float64, 1, typeof(ao)}(ao, (-1, ))
@test_throws ArgumentError OffsetArray{Float64, 1, typeof(ao)}(ao, (-2, )) # inner Constructor
@test_throws ArgumentError OffsetArray(ao, (-2, )) # convinient constructor accumulate offsets
@test_throws OverflowError OffsetArray{Float64, 1, typeof(ao)}(ao, (-2, )) # inner Constructor
@test_throws OverflowError OffsetArray(ao, (-2, )) # convinient constructor accumulate offsets

# disallow OffsetVector(::Array{<:Any, N}, offsets) where N != 1
@test_throws ArgumentError OffsetVector(zeros(2,2), (2, 2))
Expand Down Expand Up @@ -328,6 +333,7 @@ end
one_based_axes = Any[
(Base.OneTo(4), Base.OneTo(3)),
(1:4, 1:3),
(big(1):big(4), big(1):big(3)),
(CartesianIndex(1, 1):CartesianIndex(4, 3), ),
(CartesianIndex(1):CartesianIndex(4), CartesianIndex(1):CartesianIndex(3)),
(CartesianIndex(1):CartesianIndex(4), 1:3),
Expand All @@ -340,6 +346,7 @@ end

offset_axes = Any[
(-1:2, 0:2),
(big(-1):big(2), big(0):big(2)),
(CartesianIndex(-1, 0):CartesianIndex(2, 2), ),
(-1:2, CartesianIndex(0):CartesianIndex(2)),
(CartesianIndex(-1):CartesianIndex(2), CartesianIndex(0):CartesianIndex(2)),
Expand All @@ -351,7 +358,10 @@ end
(IdOffsetRange(-1:2), 0:2),
]

for inds in Any[size.(one_based_axes[1], 1), one_based_axes...]
offsets = size.(one_based_axes[1], 1)
offsets_big = map(big, offsets)

for inds in Any[offsets, offsets_big, one_based_axes...]
# test API
a = OffsetMatrix{Float64}(undef, inds)
ax = (IdOffsetRange(Base.OneTo(4), 0), IdOffsetRange(Base.OneTo(3), 0))
Expand Down Expand Up @@ -433,8 +443,8 @@ end
# overflow bounds check
a = rand(4, 3)
@test axes(OffsetMatrix(a, typemax(Int)-size(a, 1), 0)) == (IdOffsetRange(axes(a)[1], typemax(Int)-size(a, 1)), axes(a, 2))
@test_throws ArgumentError OffsetMatrix(a, typemax(Int)-size(a,1)+1, 0)
@test_throws ArgumentError OffsetMatrix(a, 0, typemax(Int)-size(a, 2)+1)
@test_throws OverflowError OffsetMatrix(a, typemax(Int)-size(a,1)+1, 0)
@test_throws OverflowError OffsetMatrix(a, 0, typemax(Int)-size(a, 2)+1)

# disallow OffsetMatrix(::Array{<:Any, N}, offsets) where N != 2
@test_throws ArgumentError OffsetMatrix(zeros(2), (2,))
Expand Down