More similar definitions and tests

Author: mtfishman

src/KroneckerArrays.jl

@@ -717,7 +717,7 @@ function Base.map!(f::typeof(-), dest::EyeKronecker, a::EyeKronecker)
   return dest
 end
 function Base.map!(f::typeof(-), dest::KroneckerEye, a::KroneckerEye)
-  map!(f, dest.a, a.a, b.a)
+  map!(f, dest.a, a.a)
   return dest
 end
 function Base.map!(f::typeof(-), dest::EyeEye, a::EyeEye)
@@ -932,30 +932,65 @@ const SquareEyeSquareEye{T,A<:SquareEye{T},B<:SquareEye{T}} = KroneckerMatrix{T,
 
 # Special case of similar for `SquareEye ⊗ A` and `A ⊗ SquareEye`.
 function Base.similar(
-  arrayt::Type{<:SquareEyeKronecker{<:Any,<:Any,A}},
+  a::SquareEyeKronecker,
   elt::Type,
+  axs::Tuple{
+    CartesianProductUnitRange{<:Integer},Vararg{CartesianProductUnitRange{<:Integer}}
+  },
+)
+  ax_a = map(ax -> ax.product.a, axs)
+  ax_b = map(ax -> ax.product.b, axs)
+  eye_ax_a = (only(unique(ax_a)),)
+  return Eye{elt}(eye_ax_a) ⊗ similar(a.b, elt, ax_b)
+end
+function Base.similar(
+  a::KroneckerSquareEye,
+  elt::Type,
+  axs::Tuple{
+    CartesianProductUnitRange{<:Integer},Vararg{CartesianProductUnitRange{<:Integer}}
+  },
+)
+  ax_a = map(ax -> ax.product.a, axs)
+  ax_b = map(ax -> ax.product.b, axs)
+  eye_ax_b = (only(unique(ax_b)),)
+  return similar(a.a, elt, ax_a) ⊗ Eye{elt}(eye_ax_b)
+end
+function Base.similar(
+  a::SquareEyeSquareEye,
+  elt::Type,
+  axs::Tuple{
+    CartesianProductUnitRange{<:Integer},Vararg{CartesianProductUnitRange{<:Integer}}
+  },
+)
+  ax_a = map(ax -> ax.product.a, axs)
+  ax_b = map(ax -> ax.product.b, axs)
+  eye_ax_a = (only(unique(ax_a)),)
+  eye_ax_b = (only(unique(ax_b)),)
+  return Eye{elt}(eye_ax_a) ⊗ Eye{elt}(eye_ax_b)
+end
+
+function Base.similar(
+  arrayt::Type{<:SquareEyeKronecker{<:Any,<:Any,A}},
   axs::NTuple{2,CartesianProductUnitRange{<:Integer}},
 ) where {A}
   ax_a = map(ax -> ax.product.a, axs)
   ax_b = map(ax -> ax.product.b, axs)
   eye_ax_a = (only(unique(ax_a)),)
-  return Eye{elt}(eye_ax_a) ⊗ similar(A, elt, ax_b)
+  return Eye{eltype(arrayt)}(eye_ax_a) ⊗ similar(A, ax_b)
 end
 function Base.similar(
   arrayt::Type{<:KroneckerSquareEye{<:Any,A}},
-  elt::Type,
   axs::NTuple{2,CartesianProductUnitRange{<:Integer}},
 ) where {A}
   ax_a = map(ax -> ax.product.a, axs)
   ax_b = map(ax -> ax.product.b, axs)
   eye_ax_b = (only(unique(ax_b)),)
-  return similar(A, elt, ax_a) ⊗ Eye{elt}(eye_ax_b)
+  return similar(A, ax_a) ⊗ Eye{eltype(arrayt)}(eye_ax_b)
 end
 function Base.similar(
-  arrayt::Type{<:SquareEyeSquareEye},
-  elt::Type,
-  axs::NTuple{2,CartesianProductUnitRange{<:Integer}},
+  arrayt::Type{<:SquareEyeSquareEye}, axs::NTuple{2,CartesianProductUnitRange{<:Integer}}
 )
+  elt = eltype(arrayt)
   ax_a = map(ax -> ax.product.a, axs)
   ax_b = map(ax -> ax.product.b, axs)
   eye_ax_a = (only(unique(ax_a)),)

test/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+DerivableInterfaces = "6c5e35bf-e59e-4898-b73c-732dcc4ba65f"
 FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
 KroneckerArrays = "05d0b138-81bc-4ff7-84be-08becefb1ccc"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

test/test_basics.jl

@@ -1,4 +1,5 @@
 using Base.Broadcast: BroadcastStyle, Broadcasted, broadcasted
+using DerivableInterfaces: zero!
 using FillArrays: Eye
 using KroneckerArrays:
   KroneckerArrays,
@@ -187,6 +188,110 @@ end
   @test 2a == (2a.a) ⊗ Eye(2)
   @test a * a == (a.a * a.a) ⊗ Eye(2)
 
+  # similar
+  a = Eye(2) ⊗ randn(3, 3)
+  for a′ in (
+    similar(a),
+    similar(a, eltype(a)),
+    similar(a, axes(a)),
+    similar(a, eltype(a), axes(a)),
+    similar(typeof(a), axes(a)),
+  )
+    @test size(a′) == (6, 6)
+    @test a′ isa KroneckerArray{eltype(a),ndims(a),typeof(a.a),typeof(a.b)}
+    @test a′.a === a.a
+  end
+
+  a = Eye(2) ⊗ randn(3, 3)
+  for args in ((Float32,), (Float32, axes(a)))
+    a′ = similar(a, args...)
+    @test size(a′) == (6, 6)
+    @test a′ isa KroneckerArray{Float32,ndims(a)}
+    @test a′.a === Eye{Float32}(2)
+  end
+
+  a = randn(3, 3) ⊗ Eye(2)
+  for a′ in (
+    similar(a),
+    similar(a, eltype(a)),
+    similar(a, axes(a)),
+    similar(a, eltype(a), axes(a)),
+    similar(typeof(a), axes(a)),
+  )
+    @test size(a′) == (6, 6)
+    @test a′ isa KroneckerArray{eltype(a),ndims(a),typeof(a.a),typeof(a.b)}
+    @test a′.b === a.b
+  end
+
+  a = randn(3, 3) ⊗ Eye(2)
+  for args in ((Float32,), (Float32, axes(a)))
+    a′ = similar(a, args...)
+    @test size(a′) == (6, 6)
+    @test a′ isa KroneckerArray{Float32,ndims(a)}
+    @test a′.b === Eye{Float32}(2)
+  end
+
+  a = Eye(3) ⊗ Eye(2)
+  for a′ in (
+    similar(a),
+    similar(a, eltype(a)),
+    similar(a, axes(a)),
+    similar(a, eltype(a), axes(a)),
+    similar(typeof(a), axes(a)),
+  )
+    @test size(a′) == (6, 6)
+    @test a′ isa KroneckerArray{eltype(a),ndims(a),typeof(a.a),typeof(a.b)}
+    @test a′.a === a.a
+    @test a′.b === a.b
+  end
+
+  a = Eye(3) ⊗ Eye(2)
+  for args in ((Float32,), (Float32, axes(a)))
+    a′ = similar(a, args...)
+    @test size(a′) == (6, 6)
+    @test a′ isa KroneckerArray{Float32,ndims(a)}
+    @test a′.a === Eye{Float32}(3)
+    @test a′.b === Eye{Float32}(2)
+  end
+
+  # DerivableInterfaces.zero!
+  for a in (Eye(2) ⊗ randn(3, 3), randn(3, 3) ⊗ Eye(2))
+    zero!(a)
+    @test iszero(a)
+  end
+  a = Eye(3) ⊗ Eye(2)
+  @test_throws ArgumentError zero!(a)
+
+  # map!(+, ...)
+  for a in (Eye(2) ⊗ randn(3, 3), randn(3, 3) ⊗ Eye(2))
+    a′ = similar(a)
+    map!(+, a′, a, a)
+    @test collect(a′) ≈ 2 * collect(a)
+  end
+  a = Eye(3) ⊗ Eye(2)
+  a′ = similar(a)
+  @test_throws ErrorException map!(+, a′, a, a)
+
+  # map!(-, ...)
+  for a in (Eye(2) ⊗ randn(3, 3), randn(3, 3) ⊗ Eye(2))
+    a′ = similar(a)
+    map!(-, a′, a, a)
+    @test norm(collect(a′)) ≈ 0
+  end
+  a = Eye(3) ⊗ Eye(2)
+  a′ = similar(a)
+  @test_throws ErrorException map!(-, a′, a, a)
+
+  # map!(-, b, a)
+  for a in (Eye(2) ⊗ randn(3, 3), randn(3, 3) ⊗ Eye(2))
+    a′ = similar(a)
+    map!(-, a′, a)
+    @test collect(a′) ≈ -collect(a)
+  end
+  a = Eye(3) ⊗ Eye(2)
+  a′ = similar(a)
+  @test_throws ErrorException map!(-, a′, a)
+
   # Eye ⊗ A
   rng = StableRNG(123)
   a = Eye(2) ⊗ randn(rng, 3, 3)