Skip to content

add offset overflow check #144

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 2 commits into from
Sep 14, 2020
Merged

add offset overflow check #144

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7d1875
add offset overflow check
johnnychen94 Sep 13, 2020
967873f
also check negative cases
johnnychen94 Sep 13, 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
10 changes: 10 additions & 0 deletions src/OffsetArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,20 @@ include("axes.jl")
struct OffsetArray{T,N,AA<:AbstractArray} <: AbstractArray{T,N}
parent::AA
offsets::NTuple{N,Int}
function OffsetArray{T, N, AA}(parent::AA, offsets::NTuple{N, Int}) where {T, N, AA<:AbstractArray}
overflow_check.(axes(parent), offsets)
new{T, N, AA}(parent, offsets)
end
end
OffsetVector{T,AA<:AbstractArray} = OffsetArray{T,1,AA}
OffsetMatrix{T,AA<:AbstractArray} = OffsetArray{T,2,AA}

function overflow_check(r, offset::T) where T
throw_offseterror() = throw(ArgumentError("Boundary overflow detected: offset $offset should be smaller than $(typemax(T) - last(r))"))
Copy link

@stevengj stevengj Sep 13, 2020

Choose a reason for hiding this comment

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

Why define a function for this?

Copy link
Member

@jishnub jishnub Sep 13, 2020

Choose a reason for hiding this comment

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

It appears to improve the performance, not entirely sure why

Copy link
Member Author

@johnnychen94 johnnychen94 Sep 13, 2020

Choose a reason for hiding this comment

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

I opened a new issue in JuliaLang/julia#37558

In this PR I just switched back to the simple version and don't tweak it; IMO 5-10ns difference isn't critical to our use case.

if offset > 0 && last(r) > typemax(T) - offset
throw_offseterror()
end
end
## OffsetArray constructors

offset(axparent::AbstractUnitRange, ax::AbstractUnitRange) = first(ax) - first(axparent)
Expand Down
8 changes: 8 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using OffsetArrays
using OffsetArrays: IdentityUnitRange, no_offset_view
using OffsetArrays: IdOffsetRange
using Test, Aqua
using LinearAlgebra
using DelimitedFiles
Expand Down Expand Up @@ -125,6 +126,9 @@ end
w = zeros(5:6)
@test OffsetVector(w, :) == OffsetArray(w, (:,)) == OffsetArray(w, :) == OffsetArray(w, axes(w))
@test axes(OffsetVector(w, :)) == axes(w)

@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)
end

@testset "OffsetMatrix constructors" begin
Expand Down Expand Up @@ -158,6 +162,10 @@ end

@test axes(OffsetMatrix(w, :, CartesianIndices((0:1,)))) == (3:4, 0:1)
@test axes(OffsetMatrix(w, CartesianIndices((0:1,)), :)) == (0:1, 5:6)

@test axes(OffsetMatrix(v, typemax(Int)-size(v, 1), 0)) == (IdOffsetRange(axes(v)[1], typemax(Int)-size(v, 1)), axes(v, 2))
@test_throws ArgumentError OffsetMatrix(v, typemax(Int)-size(v,1)+1, 0)
@test_throws ArgumentError OffsetMatrix(v, 0, typemax(Int)-size(v, 2)+1)
end

@testset "construct OffsetArray with CartesianIndices" begin
Expand Down