Merge pull request #46 from JuliaArrays/teh/fix_readme_examples

Test and fix the code in the README

Author: timholy

src/search.jl

@@ -38,9 +38,16 @@ end
 
 if VERSION > v"0.5.0-dev+4557"
     # When running with "--check-bounds=yes" (like on Travis), the bounds-check isn't elided
+    @inline function Base.unsafe_getindex{T}(v::Range{T}, i::Integer)
+        convert(T, first(v) + (i-1)*step(v))
+    end
     @inline function Base.unsafe_getindex{T}(r::FloatRange{T}, i::Integer)
         convert(T, (r.start + (i-1)*r.step)/r.divisor)
     end
+    @inline function Base.unsafe_getindex{T<:Integer}(r::StepRange, s::Range{T})
+        st = oftype(r.start, r.start + (first(s)-1)*step(r))
+        range(st, step(r)*step(s), length(s))
+    end
     @inline function Base.unsafe_getindex(r::FloatRange, s::OrdinalRange)
         FloatRange(r.start + (first(s)-1)*r.step, step(s)*r.step, length(s), r.divisor)
     end

test/REQUIRE

@@ -1 +1,2 @@
 OffsetArrays
+SIUnits

test/indexing.jl

@@ -80,15 +80,47 @@ v = AxisArray(collect(.1:.1:10.0), .1:.1:10.0)
 @test v[:] == v.data[:] == v[Axis{:row}(:)]
 @test v[3:8] == v.data[3:8] == v[ClosedInterval(.25,.85)] == v[Axis{:row}(3:8)] == v[Axis{:row}(ClosedInterval(.22,.88))]
 
-# Test repeated intervals
-A = AxisArray([1:100 -1:-1:-100], .1:.1:10.0, [:c1, :c2])
-@test A[2.0..3.0, :] == A[atindex(-0.5..0.5, 25), :] == [20:30 -20:-1:-30]
-@test A[2.0..3.0, [:c1,:c2]] == A[atindex(-0.5..0.5, 25), [:c1, :c2]] == [20:30 -20:-1:-30]
-@test A[2.0..3.0, :c1] == A[atindex(-0.5..0.5, 25), :c1] == collect(20:30)
-@test A[atindex(-0.5..0.5, 25), :c1] == collect(20:30)
-@test A[atindex(-0.5..0.5, [25, 35]), :c1] == [20:30 30:40]
-@test_throws BoundsError A[atindex(-0.5..0.5, 5), :c1]
-@test_throws BoundsError A[atindex(-0.5..0.5, [5, 15, 25]), :]
+# Test repeated intervals, for different range types
+
+# First, since integers mean "location" rather than value, we have to
+# create a number type from which we build a StepRange but which is
+# not an Int.
+module IL  # put in a module so this file can be re-run
+immutable IntLike <: Number
+    val::Int
+end
+Base.one(x::IntLike) = IntLike(0)
+Base.zero(x::IntLike) = IntLike(0)
+Base.isless(x::IntLike, y::IntLike) = isless(x.val, y.val)
+Base.:+(x::IntLike, y::IntLike) = IntLike(x.val+y.val)
+Base.:-(x::IntLike, y::IntLike) = IntLike(x.val-y.val)
+Base.:/(x::IntLike, y::IntLike) = x.val / y.val
+Base.rem(x::IntLike, y::IntLike) = IntLike(rem(x.val, y.val))
+Base.div(x::IntLike, y::IntLike) = div(x.val, y.val)
+Base.:*(x::IntLike, y::Int) = IntLike(x.val * y)
+Base.:*(x::Int, y::IntLike) = y*x
+Base.:/(x::IntLike, y::Int) = IntLike(x.val / y)
+Base.promote_rule(::Type{IntLike}, ::Type{Int}) = Int
+Base.convert(::Type{Int}, x::IntLike) = x.val
+using AxisArrays
+AxisArrays.axistrait(::AbstractVector{IntLike}) = AxisArrays.Dimensional
+end
+
+for (r, Irel) in ((0.1:0.1:10.0, -0.5..0.5),  # FloatRange
+                  (IL.IntLike(1):IL.IntLike(1):IL.IntLike(100),
+                   IL.IntLike(-5)..IL.IntLike(5))) # StepRange
+    Iabs = r[20]..r[30]
+    A = AxisArray([1:100 -1:-1:-100], r, [:c1, :c2])
+    @test A[Iabs, :] == A[atindex(Irel, 25), :] == [20:30 -20:-1:-30]
+    @test A[Iabs, :] == A[r[25]+Irel, :] == [20:30 -20:-1:-30]
+    @test A[Iabs, [:c1,:c2]] == A[atindex(Irel, 25), [:c1, :c2]] == [20:30 -20:-1:-30]
+    @test A[Iabs, :c1] == A[atindex(Irel, 25), :c1] == collect(20:30)
+    @test A[atindex(Irel, 25), :c1] == collect(20:30)
+    @test A[atindex(Irel, [25, 35]), :c1] == [20:30 30:40]
+    @test A[r[[25, 35]] + Irel,  :c1] == [20:30 30:40]
+    @test_throws BoundsError A[atindex(Irel, 5), :c1]
+    @test_throws BoundsError A[atindex(Irel, [5, 15, 25]), :]
+end
 
 # Indexing with CartesianIndex{0}
 A = AxisArray(reshape(1:15, 3, 5), :x, :y)

test/readme.jl

@@ -0,0 +1,53 @@
+# Intended to ensure the README stays working (this is a copy)
+
+using AxisArrays, SIUnits
+import SIUnits.ShortUnits: s, ms, µs
+
+fs = 40000
+y = randn(60*fs+1)*3
+for spk = (sin(0.8:0.2:8.6) .* [0:0.01:.1; .15:.1:.95; 1:-.05:.05]   .* 50,
+           sin(0.8:0.4:8.6) .* [0:0.02:.1; .15:.1:1; 1:-.2:.1] .* 50)
+    i = rand(round(Int,.001fs):1fs)
+    while i+length(spk)-1 < length(y)
+        y[i:i+length(spk)-1] += spk
+        i += rand(round(Int,.001fs):1fs)
+    end
+end
+
+A = AxisArray([y 2y], Axis{:time}(0s:1s/fs:60s), Axis{:chan}([:c1, :c2]))
+A[Axis{:time}(4)]
+A[Axis{:chan}(:c2), Axis{:time}(1:5)]
+ax = A[40µs .. 220µs, :c1]
+axes(ax, 1)
+A[atindex(-90µs .. 90µs, 5), :c2]
+idxs = find(diff(A[:,:c1] .< -15) .> 0)
+spks = A[atindex(-200µs .. 800µs, idxs), :c1]
+
+
+# # A possible "dynamic verification" strategy
+# const readmefile = joinpath(dirname(dirname(@__FILE__)), "README.md")
+
+# function extract_julialines(iowr, filein)
+#     open(filein) do iord
+#         while !eof(iord)
+#             line = readline(iord)
+#             if startswith(line, "julia>")
+#                 print(iowr, line[8:end])
+#                 while !eof(iord)
+#                     line = readline(iord)
+#                     if !startswith(line, "    ")
+#                         break
+#                     end
+#                     print(iowr, line[8:end])
+#                 end
+#             end
+#         end
+#     end
+# end
+
+# tmpfile, iowr = mktemp()
+# extract_julialines(iowr, readmefile)
+# close(iowr)
+
+# include(tmpfile)
+# rm(tmpfile)

test/runtests.jl

@@ -10,4 +10,6 @@ include("sortedvector.jl")
 include("search.jl")
 include("combine.jl")
 
+include("readme.jl")
+
 nothing