Define similartype for BitArray (#36)

Author: mtfishman

Project.toml

@@ -1,7 +1,7 @@
 name = "TypeParameterAccessors"
 uuid = "7e5a90cf-f82e-492e-a09b-e3e26432c138"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.3.3"
+version = "0.3.4"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

src/base/similartype.jl

@@ -28,6 +28,13 @@ end
   return set_eltype(arraytype, eltype)
 end
 
+function similartype(arraytype::Type{<:BitArray}, elt::Type)
+  if is_parameter_specified(arraytype, ndims)
+    return Array{elt,ndims(arraytype)}
+  end
+  return Array{elt}
+end
+
 @traitfn function similartype(
   arraytype::Type{ArrayT}, dims::Tuple
 ) where {ArrayT; !IsWrappedArray{ArrayT}}

test/test_similartype.jl

@@ -1,5 +1,6 @@
-using Test: @test, @test_broken, @testset
 using LinearAlgebra: Adjoint, Diagonal
+using Test: @test, @test_broken, @testset
+using TestExtras: @constinferred
 using TypeParameterAccessors: NDims, similartype
 
 @testset "TypeParameterAccessors similartype" begin
@@ -10,10 +11,14 @@ using TypeParameterAccessors: NDims, similartype
   @test similartype(Array, NDims(2)) == Matrix
   @test similartype(Array, Float64, (2, 2)) == Matrix{Float64}
   @test similartype(Array, Float64, NDims(2)) == Matrix{Float64}
+
+  # Adjoint
   @test similartype(Adjoint{Float32,Matrix{Float32}}, Float64, (2, 2, 2)) ==
     Array{Float64,3}
   @test similartype(Adjoint{Float32,Matrix{Float32}}, Float64, NDims(3)) == Array{Float64,3}
   @test similartype(Adjoint{Float32,Matrix{Float32}}, Float64) == Matrix{Float64}
+
+  # Diagonal
   @test similartype(Diagonal{Float32,Vector{Float32}}) == Matrix{Float32}
   @test similartype(Diagonal{Float32,Vector{Float32}}, Float64) == Matrix{Float64}
   @test similartype(Diagonal{Float32,Vector{Float32}}, (2, 2, 2)) == Array{Float32,3}
@@ -22,4 +27,18 @@ using TypeParameterAccessors: NDims, similartype
     Array{Float64,3}
   @test similartype(Diagonal{Float32,Vector{Float32}}, Float64, NDims(3)) ==
     Array{Float64,3}
+
+  # BitArray
+  @test @constinferred(similartype(BitArray)) == BitArray
+  @test @constinferred(similartype(BitVector)) == BitVector
+  @test @constinferred(similartype(BitArray, (2, 2, 2))) == BitArray{3}
+  @test @constinferred(similartype(BitVector, (2, 2, 2))) == BitArray{3}
+  @test @constinferred(similartype(BitArray, NDims(3))) == BitArray{3}
+  @test @constinferred(similartype(BitVector, NDims(3))) == BitArray{3}
+  @test @constinferred(similartype(BitArray, Float32)) == Array{Float32}
+  @test @constinferred(similartype(BitVector, Float32)) == Vector{Float32}
+  @test @constinferred(similartype(BitArray, Float32, (2, 2, 2))) == Array{Float32,3}
+  @test @constinferred(similartype(BitVector, Float32, (2, 2, 2))) == Array{Float32,3}
+  @test @constinferred(similartype(BitArray, Float32, NDims(3))) == Array{Float32,3}
+  @test @constinferred(similartype(BitVector, Float32, NDims(3))) == Array{Float32,3}
 end