Merge pull request #21 from JuliaReinforcementLearning/tj/fix_20

Add boundscheck to view

Author: jeremiahpslewis

Project.toml

@@ -1,7 +1,7 @@
 name = "CircularArrayBuffers"
 uuid = "9de3a189-e0c0-4e15-ba3b-b14b9fb0aec1"
 authors = ["Jun Tian <[email protected]> and contributors"]
-version = "0.1.12"
+version = "0.1.13"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

src/CircularArrayBuffers.jl

@@ -69,8 +69,8 @@ Base.getindex(cb::CircularVectorBuffer, i, j) = getindex(cb.buffer, _buffer_fram
 Base.setindex!(cb::CircularArrayBuffer{T,N}, v, i::Int) where {T,N} = setindex!(cb.buffer, v, _buffer_index(cb, i))
 Base.setindex!(cb::CircularArrayBuffer{T,N}, v, I...) where {T,N} = setindex!(cb.buffer, v, Base.front(I)..., _buffer_frame(cb, Base.last(I)))
 
-Base.view(cb::CircularArrayBuffer, i::Int) = view(cb.buffer, _buffer_index(cb, i))
-Base.view(cb::CircularArrayBuffer, I...) = view(cb.buffer, Base.front(I)..., _buffer_frame(cb, Base.last(I)))
+Base.view(cb::CircularArrayBuffer, i::Int) = (@boundscheck checkbounds(cb, i); view(cb.buffer, _buffer_index(cb, i)))
+Base.view(cb::CircularArrayBuffer, I...) = (@boundscheck checkbounds(cb, I...); view(cb.buffer, Base.front(I)..., _buffer_frame(cb, Base.last(I))))
 
 capacity(cb::CircularArrayBuffer{T,N}) where {T,N} = size(cb.buffer, N)
 isfull(cb::CircularArrayBuffer) = cb.nframes == capacity(cb)

test/runtests.jl

@@ -16,6 +16,13 @@ CUDA.allowscalar(false)
         @test b[1] == 0
     end
 
+    # https://github.com/JuliaReinforcementLearning/CircularArrayBuffers.jl/issues/20
+    @testset "bound check with view" begin
+        b = CircularArrayBuffer([1 2 3; 4 5 6])
+        @test_throws BoundsError @view b[:, 4]
+        @test_throws BoundsError @view b[:, 9]
+    end
+
     @testset "1D vector" begin
         b = CircularArrayBuffer([[1], [2, 3]])
         push!(b, [4, 5, 6])