first attempt to have compatibility with EllipsisNotation.jl, cf. #39 (#41)

* first attempt to have compatibility with EllipsisNotation.jl, cf. #39

* revert 2184ee1 except new tests

* restrict overwritten method of view to known index types

* add tests for Cartesian indices

* set version to v0.4.5

Author: ranocha

Project.toml

@@ -1,7 +1,7 @@
 name = "HybridArrays"
 uuid = "1baab800-613f-4b0a-84e4-9cd3431bfbb9"
 authors = ["Mateusz Baran <[email protected]>"]
-version = "0.4.4"
+version = "0.4.5"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -15,8 +15,9 @@ julia = "1"
 
 [extras]
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
+EllipsisNotation = "da5c29d0-fa7d-589e-88eb-ea29b0a81949"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "Random", "ArrayInterface"]
+test = ["Test", "Random", "ArrayInterface", "EllipsisNotation"]

src/indexing.jl

@@ -298,7 +298,7 @@ end
 
 @inline function Base.view(
     a::HybridArray{S},
-    indices...,
+    indices::Union{Int, AbstractArray, Colon}...,
 ) where {S}
     inner_view = invoke(view, Tuple{AbstractArray, typeof(indices).parameters...}, a, indices...)
     return _view_hybrid(a, all_dynamic_fixed_val(S, indices...), inner_view, indices...)

test/nonstandard_indices.jl

@@ -0,0 +1,86 @@
+
+module TestEllipsisNotationCompat # use a module to avoid cluttering the global namespace
+
+using EllipsisNotation
+using HybridArrays
+using Test
+
+
+@testset "Compatibility with EllipsisNotation" begin
+  u_array  = rand(2, 10)
+  u_hybrid = HybridArray{Tuple{2, HybridArrays.Dynamic()}}(copy(u_array))
+  @test u_hybrid        ≈ u_array
+  @test u_hybrid[1, ..] ≈ u_array[1, ..]
+  @test u_hybrid[.., 1] ≈ u_array[.., 1]
+  @test u_hybrid[..]    ≈ u_array[..]
+
+  @test_broken typeof(u_hybrid[1, ..]) == typeof(u_hybrid[1, :])
+  @test_broken typeof(u_hybrid[.., 1]) == typeof(u_hybrid[:, 1])
+  @test typeof(u_hybrid[..])    == typeof(u_hybrid[:, :])
+
+  @inferred u_hybrid[1, ..]
+  @inferred u_hybrid[.., 1]
+  @inferred u_hybrid[..]
+
+  let new_values = rand(10)
+    u_array[1, ..]  .= new_values
+    u_hybrid[1, ..] .= new_values
+    @test u_hybrid        ≈ u_array
+    @test u_hybrid[1, ..] ≈ u_array[1, ..]
+    @test u_hybrid[.., 1] ≈ u_array[.., 1]
+    @test u_hybrid[..]    ≈ u_array[..]
+  end
+
+  let new_values = rand(2)
+    u_array[.., 1]  .= new_values
+    u_hybrid[.., 1] .= new_values
+    @test u_hybrid        ≈ u_array
+    @test u_hybrid[1, ..] ≈ u_array[1, ..]
+    @test u_hybrid[.., 1] ≈ u_array[.., 1]
+    @test u_hybrid[..]    ≈ u_array[..]
+  end
+
+  let new_values = rand(2, 10)
+    u_array  .= new_values
+    u_hybrid .= new_values
+    @test u_hybrid        ≈ u_array
+    @test u_hybrid[1, ..] ≈ u_array[1, ..]
+    @test u_hybrid[.., 1] ≈ u_array[.., 1]
+    @test u_hybrid[..]    ≈ u_array[..]
+  end
+end
+
+
+@testset "Compatibility with Cartesian indices" begin
+  u_array  = rand(2, 3, 4)
+  u_hybrid = HybridArray{Tuple{2, 3, 4}}(copy(u_array))
+  @test u_hybrid        ≈ u_array
+  @test u_hybrid[CartesianIndex(1, 2), :] ≈ u_array[CartesianIndex(1, 2), :]
+  @test u_hybrid[:, CartesianIndex(1, 2)] ≈ u_array[:, CartesianIndex(1, 2)]
+
+  @test_broken typeof(u_hybrid[CartesianIndex(1, 2), :]) == typeof(u_hybrid[1, 2, :])
+  @test_broken typeof(u_hybrid[:, CartesianIndex(1, 2)]) == typeof(u_hybrid[:, 1, 2])
+
+  @inferred u_hybrid[CartesianIndex(1, 2), :]
+  @inferred u_hybrid[:, CartesianIndex(1, 2)]
+  @inferred u_hybrid[CartesianIndex(1, 2, 3)]
+
+  let new_values = rand(4)
+    u_array[CartesianIndex(1, 2), :]  .= new_values
+    u_hybrid[CartesianIndex(1, 2), :] .= new_values
+    @test u_hybrid        ≈ u_array
+    @test u_hybrid[CartesianIndex(1, 2), :] ≈ u_array[CartesianIndex(1, 2), :]
+    @test u_hybrid[:, CartesianIndex(1, 2)] ≈ u_array[:, CartesianIndex(1, 2)]
+  end
+
+  let new_values = rand(2)
+    u_array[:, CartesianIndex(1, 2)]  .= new_values
+    u_hybrid[:, CartesianIndex(1, 2)] .= new_values
+    @test u_hybrid        ≈ u_array
+    @test u_hybrid[CartesianIndex(1, 2), :] ≈ u_array[CartesianIndex(1, 2), :]
+    @test u_hybrid[:, CartesianIndex(1, 2)] ≈ u_array[:, CartesianIndex(1, 2)]
+  end
+end
+
+
+end # module

test/runtests.jl

@@ -158,6 +158,7 @@ include("arraymath.jl")
 include("broadcast.jl")
 include("linalg.jl")
 include("ssubarray.jl")
+include("nonstandard_indices.jl")
 if VERSION >= v"1.2"
     include("array_interface_compat.jl")
 end