changeset 1476:62f9d0387a2a feature/grids/componentview

Introduce a view type and implement sliced indexing for the components.
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 01 Dec 2023 14:58:05 +0100
parents 76b190ca9a27
children a7689021d4c2 ae2dbfb984a9
files src/Grids/Grids.jl src/Grids/grid.jl test/Grids/grid_test.jl
diffstat 3 files changed, 55 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/Grids.jl	Fri Dec 01 13:36:47 2023 +0100
+++ b/src/Grids/Grids.jl	Fri Dec 01 14:58:05 2023 +0100
@@ -17,6 +17,7 @@
 export refine
 export eval_on
 export componentview
+export ArrayComponentView
 
 export BoundaryIdentifier
 export TensorGridBoundary
--- a/src/Grids/grid.jl	Fri Dec 01 13:36:47 2023 +0100
+++ b/src/Grids/grid.jl	Fri Dec 01 14:58:05 2023 +0100
@@ -40,12 +40,38 @@
 component_type(T::Type) = eltype(eltype(T))
 component_type(t) = component_type(typeof(t))
 
-function componentview(gf, component_index...)
-    A = reinterpret(reshape, component_type(gf), gf)
+componentview(gf, component_index...) = ArrayComponentView(gf, component_index)
+
+struct ArrayComponentView{CT,T,D,AT <: AbstractArray{T,D}, IT} <: AbstractArray{CT,D}
+    v::AT
+    component_index::IT
+
+    function ArrayComponentView(v, component_index)
+        CT = typeof(first(v)[component_index...])
+        return new{CT, eltype(v), ndims(v), typeof(v), typeof(component_index)}(v,component_index)
+    end
+end
 
-    component_linear_index = LinearIndices(first(gf))[component_index...]
-    return @view A[component_linear_index,:,:]
-end
+Base.size(cv) = size(cv.v)
+Base.getindex(cv::ArrayComponentView, i::Int) = cv.v[i][cv.component_index...]
+Base.getindex(cv::ArrayComponentView, I::Vararg{Int}) = cv.v[I...][cv.component_index...]
+IndexStyle(::Type{<:ArrayComponentView{<:Any,<:Any,AT}}) where AT = IndexStyle(AT)
+
+# TODO: Implement the remaining optional methods from the array interface
+# setindex!(A, v, i::Int)
+# setindex!(A, v, I::Vararg{Int, N})
+# iterate
+# length(A)
+# similar(A)
+# similar(A, ::Type{S})
+# similar(A, dims::Dims)
+# similar(A, ::Type{S}, dims::Dims)
+# # Non-traditional indices
+# axes(A)
+# similar(A, ::Type{S}, inds)
+# similar(T::Union{Type,Function}, inds)
+
+# TODO: Implement a more general ComponentView that can handle non-AbstractArrays.
 
 """
     refine(g::Grid, r)
--- a/test/Grids/grid_test.jl	Fri Dec 01 13:36:47 2023 +0100
+++ b/test/Grids/grid_test.jl	Fri Dec 01 14:58:05 2023 +0100
@@ -70,8 +70,29 @@
     @test componentview(v, 1, 2) == [3 .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
     @test componentview(v, 2, 1) == [2 .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
 
-    # should work with colon
-    # should return a view which can be index like the grid function
+    @test componentview(v, 1, :) == [@SVector[1,3] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+    @test componentview(v, 2, :) == [@SVector[2,4] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+    @test componentview(v, :, 1) == [@SVector[1,2] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+    @test componentview(v, :, 2) == [@SVector[3,4] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+
+
+    A = @SMatrix[
+        1 4 7;
+        2 5 8;
+        3 6 9;
+    ]
+    v = [A .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+    @test componentview(v, 1:2, 1:2) == [@SMatrix[1 4;2 5] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+    @test componentview(v, 2:3, 1:2) == [@SMatrix[2 5;3 6] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+end
+
+@testset "ArrayComponentView" begin
+    v = [@SMatrix[1 3; 2 4] .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+
+    @test ArrayComponentView(v, (1,1)) == ArrayComponentView(v, (1,1))
+    @test ArrayComponentView(v, (1,1)) == ArrayComponentView(copy(v), (1,1))
+    @test ArrayComponentView(v, (1,1)) == [1 .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4]
+    @test [1 .+ 100*i .+ 10*j for i ∈ 1:3, j∈ 1:4] == ArrayComponentView(v, (1,1))
 end
 
 @testset "_ncomponents" begin