Implement Base.setindex with CartesianIndex (#1034)

* Implement Base.setindex with CartesianIndex

* Update src/deque.jl

Co-authored-by: Jan Weidner <jw3126@gmail.com>

* Implement setindex indexing via to_indices

* White space change to trigger CI

* Simplify code

Co-authored-by: Jan Weidner <jw3126@gmail.com>

Author: eschnett

README.md

@@ -64,9 +64,9 @@ using LinearAlgebra
 using StaticArrays
 
 # Use the convenience constructor type `SA` to create vectors and matrices
-SA[1, 2, 3]     isa SVector{3,Int}
-SA_F64[1, 2, 3] isa SVector{3,Float64}
-SA_F32[1, 2, 3] isa SVector{3,Float32}
+SA[1, 2, 3]      isa SVector{3,Int}
+SA_F64[1, 2, 3]  isa SVector{3,Float64}
+SA_F32[1, 2, 3]  isa SVector{3,Float32}
 SA[1 2; 3 4]     isa SMatrix{2,2,Int}
 SA_F64[1 2; 3 4] isa SMatrix{2,2,Float64}
 

src/deque.jl

@@ -195,4 +195,4 @@ julia> setindex(@SMatrix[2 4; 6 8], 1, 2)
 end
 
 # TODO proper multidimension boundscheck
-@propagate_inbounds setindex(a::StaticArray, x, inds::Int...) = setindex(a, x, LinearIndices(a)[inds...])
+@propagate_inbounds setindex(a::StaticArray, x, inds...) = setindex(a, x, LinearIndices(a)[inds...])

test/deque.jl

@@ -34,6 +34,10 @@ end
     @test @inferred(setindex(v1, 5.0, 2)) == @SVector [1., 5., 3.]
     @test_throws BoundsError setindex(v1, 5.0, 0)
     @test_throws BoundsError setindex(v1, 5.0, 4)
+    @test @inferred(setindex(v1, 5, CartesianIndex(2))) == setindex(v1, 5, 2)
+    @test @inferred(setindex(v1, 5.0, CartesianIndex(2))) == setindex(v1, 5.0, 2)
+    @test_throws BoundsError setindex(v1, 5.0, CartesianIndex(0))
+    @test_throws BoundsError setindex(v1, 5.0, CartesianIndex(4))
 
     v2 = @SMatrix [1 2; 3 4]
     @test @inferred(setindex(v2, 7, 1)) == @SMatrix [7 2; 3 4]
@@ -46,11 +50,16 @@ end
     @test @inferred(setindex(v2, 7, 2, 2)) == @SMatrix [1 2; 3 7]
     @test_throws BoundsError setindex(v2, 7, 0)
     @test_throws BoundsError setindex(v2, 7, 5)
+    @test @inferred(setindex(v2, 7, CartesianIndex(1, 1))) == setindex(v2, 7, 1, 1)
+    @test @inferred(setindex(v2, 7, CartesianIndex(2, 1))) == setindex(v2, 7, 2, 1)
+    @test @inferred(setindex(v2, 7, CartesianIndex(1, 2))) == setindex(v2, 7, 1, 2)
+    @test @inferred(setindex(v2, 7, CartesianIndex(2, 2))) == setindex(v2, 7, 2, 2)
 
     v3 = @SArray ones(2, 2, 2)
     @test @inferred(setindex(v3, 7, 2, 1, 2)) == reshape([1, 1, 1, 1, 1, 7, 1, 1], (2, 2, 2))
     @test_throws BoundsError setindex(v3, 7, 0)
     @test_throws BoundsError setindex(v3, 7, 9)
+    @test @inferred(setindex(v3, 7, CartesianIndex(2, 1, 2))) == setindex(v3, 7, 2, 1, 2)
 
     # TODO: still missing proper multidimensional bounds checking
     # These should throw BoundsError, but don't