unit test cases and benchmarks

Author: KDr2

Project.toml

@@ -16,6 +16,7 @@ julia = "1.3"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 
 [targets]
-test = ["Test"]
+test = ["Test", "BenchmarkTools"]

src/tarray.jl

@@ -31,6 +31,7 @@ end
 
 TArray{T}(d::Integer...) where T = TArray(T, d)
 TArray{T}(::UndefInitializer, d::Integer...) where T = TArray(T, d)
+TArray{T}(::UndefInitializer, dim::NTuple{N,Int}) where {T,N} = TArray(T, dim)
 TArray{T,N}(d::Vararg{<:Integer,N}) where {T,N} = TArray(T, d)
 TArray{T,N}(::UndefInitializer, d::Vararg{<:Integer,N}) where {T,N} = TArray{T,N}(d)
 TArray{T,N}(dim::NTuple{N,Int}) where {T,N} = TArray(T, dim)
@@ -136,7 +137,7 @@ function Base.show(io::IO, ::MIME"text/plain", x::TArray)
     arr = x.orig_task.storage[x.ref][2]
     @warn "Here shows the originating task's storage, " *
         "not the current task's storage. " *
-        "Please explictly call show(::TArray) to display the current task's version of a TArray."
+        "Please explicitly call show(::TArray) to display the current task's version of a TArray."
     show(io,  MIME("text/plain"), arr)
 end
 
@@ -220,13 +221,14 @@ Base.:-(x::TArray) = (- _get(x)) |> localize
 Base.transpose(x::TArray) = transpose(_get(x)) |> localize
 Base.adjoint(x::TArray) = adjoint(_get(x)) |> localize
 Base.repeat(x::TArray; kw...) = repeat(_get(x); kw...) |> localize
-Base.hcat(x::TArray, rest...) = hcat(_get(x), _get.(rest)...) |> localize
-Base.hcat(x::AbstractArray, y::TArray, rest...) = hcat(x, _get(y), _get.(rest)...) |> localize
-Base.vcat(x::TArray, rest...) = vcat(_get(x), _get.(rest)...) |> localize
-Base.vcat(x::AbstractArray, y::TArray, rest...) = vcat(x, _get(y), _get.(rest)...) |> localize
-Base.cat(x::TArray, rest...; dims) = cat(_get(x), _get.(rest)...; dims = dims) |> localize
-Base.cat(x::AbstractArray, y::TArray, rest...; dims) =
-    cat(x, _get(y), _get.(rest)...; dims = dims) |> localize
+
+Base.hcat(xs::Union{TArray{T,1}, TArray{T,2}}...) where T =
+    hcat(_get.(xs)...) |> localize
+Base.vcat(xs::Union{TArray{T,1}, TArray{T,2}}...) where T =
+    vcat(_get.(xs)...) |> localize
+Base.cat(xs::Union{TArray{T,1}, TArray{T,2}}...; dims) where T =
+    cat(_get.(xs)...; dims = dims) |> localize
+
 
 Base.reshape(x::TArray, dims::Union{Colon,Int}...) = reshape(_get(x), dims) |> localize
 Base.reshape(x::TArray, dims::Tuple{Vararg{Union{Int,Colon}}}) =
@@ -256,6 +258,9 @@ Base.:*(x::TArray, y::TArray) = _get(x) * _get(y) |> localize
 Base.:*(x::AbstractArray, y::TArray) = x * _get(y) |> localize
 Base.:*(x::TArray, y::AbstractArray) = _get(x) * y |> localize
 
+# broadcast
+Base.BroadcastStyle(::Type{TArray{T, N}}) where {T, N} = Broadcast.ArrayStyle{TArray}()
+Broadcast.broadcasted(::Broadcast.ArrayStyle{TArray}, f, args...) = f.(_get.(args)...) |> localize
 
 import LinearAlgebra
 import LinearAlgebra:  \, /, inv, det, logdet, logabsdet, norm

test/benchmarks.jl

@@ -0,0 +1,21 @@
+using BenchmarkTools
+using Libtask
+
+println("= Benchmarks on Arrays =")
+A = rand(100, 100)
+x, y =  abs.(rand(Int, 2) .% 100)
+print("indexing: ")
+@btime $A[$x, $y] + $A[$x, $y]
+print("set indexing: ")
+@btime $A[$x, $y] = 1
+print("broadcast: ")
+@btime $A .+ $A
+
+println("= Benchmarks on TArrays =")
+TA = Libtask.localize(deepcopy(A))
+print("indexing: ")
+@btime $TA[$x, $y] + $TA[$x, $y]
+print("set indexing: ")
+@btime $TA[$x, $y] = 1
+print("broadcast: ")
+@btime $TA .+ $TA

test/runtests.jl

@@ -4,3 +4,7 @@ using Test
 include("ctask.jl")
 include("tarray.jl")
 include("tref.jl")
+
+if get(ENV, "BENCHMARK", nothing) != nothing
+    include("benchmarks.jl")
+end

test/tarray.jl

@@ -34,7 +34,7 @@
         @test pop!(ta1_2) == 2
     end
 
-    @testset "other methods" begin
+    @testset "constructors and conversion" begin
         ta2 = TArray{Int}(4, 4)
         @test ta2 isa TArray{Int,2}
         @test size(ta2) == (4, 4)
@@ -101,6 +101,24 @@
         ta7 = TArray{Int, 2}((2, 2))
     end
 
+    @testset "stdlib functions" begin
+        ta = TArray{Int}(4, 4)
+
+        @test view(ta, 3:5) isa TArray{Int, 1}
+        @test view(ta, 3:5) == ta[3:5]
+
+        @test -ta isa TArray{Int, 2}
+        @test -(-ta) == ta
+
+        @test transpose(ta)[2, 3] == ta[3, 2]
+
+        @test repeat(ta, 2) == vcat(ta, ta)
+
+        @test repeat(ta, 1, 2) == hcat(ta, ta)
+
+        @test ta .+ ta == Libtask._get(ta) .+ Libtask._get(ta)
+    end
+
     @testset "task copy" begin
         function f()
             t = TArray(Int, 1)