Skip to content

Rewrite broadcasting and mapping to make it simpler and more general #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mtfishman merged 6 commits into from
Jun 21, 2025
Merged

Rewrite broadcasting and mapping to make it simpler and more general #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
905b72f
Simplify and generalize map and broadcasting
mtfishman Jun 21, 2025
8d04743
Fixes for FillArrays
mtfishman Jun 21, 2025
e363e04
Fix ambiguity error
mtfishman Jun 21, 2025
6dfe480
Fix tests
mtfishman Jun 21, 2025
3f162f3
Cleanup
mtfishman Jun 21, 2025
36f1875
Add missing file
mtfishman Jun 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "KroneckerArrays"
uuid = "05d0b138-81bc-4ff7-84be-08becefb1ccc"
authors = ["ITensor developers <[email protected]> and contributors"]
version = "0.1.17"
version = "0.1.18"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
1 change: 1 addition & 0 deletions src/KroneckerArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ module KroneckerArrays

export ⊗, ×

include("linearcombination.jl")
include("cartesianproduct.jl")
include("kroneckerarray.jl")
include("linearalgebra.jl")
Expand Down
217 changes: 79 additions & 138 deletions src/fillarrays/kroneckerarray.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,144 +81,6 @@ function DerivableInterfaces.zero!(a::EyeEye)
return throw(ArgumentError("Can't zero out `Eye ⊗ Eye`."))
end

function Base.:*(a::Number, b::EyeKronecker)
return b.a ⊗ (a * b.b)
end
function Base.:*(a::Number, b::KroneckerEye)
return (a * b.a) ⊗ b.b
end
function Base.:*(a::Number, b::EyeEye)
return error("Can't multiply `Eye ⊗ Eye` by a number.")
end
function Base.:*(a::EyeKronecker, b::Number)
return a.a ⊗ (a.b * b)
end
function Base.:*(a::KroneckerEye, b::Number)
return (a.a * b) ⊗ a.b
end
function Base.:*(a::EyeEye, b::Number)
return error("Can't multiply `Eye ⊗ Eye` by a number.")
end

function Base.:-(a::EyeKronecker)
return a.a ⊗ (-a.b)
end
function Base.:-(a::KroneckerEye)
return (-a.a) ⊗ a.b
end
function Base.:-(a::EyeEye)
return error("Can't multiply `Eye ⊗ Eye` by a number.")
end

for op in (:+, :-)
@eval begin
function Base.$op(a::EyeKronecker, b::EyeKronecker)
if a.a ≠ b.a
return throw(
ArgumentError(
"KroneckerArray addition is only supported when the first or secord arguments match.",
),
)
end
return a.a ⊗ $op(a.b, b.b)
end
function Base.$op(a::KroneckerEye, b::KroneckerEye)
if a.b ≠ b.b
return throw(
ArgumentError(
"KroneckerArray addition is only supported when the first or secord arguments match.",
),
)
end
return $op(a.a, b.a) ⊗ a.b
end
function Base.$op(a::EyeEye, b::EyeEye)
if a.b ≠ b.b
return throw(
ArgumentError(
"KroneckerArray addition is only supported when the first or secord arguments match.",
),
)
end
return $op(a.a, b.a) ⊗ a.b
end
end
end

function Base.map!(f::typeof(identity), dest::EyeKronecker, src::EyeKronecker)
map!(f, dest.b, src.b)
return dest
end
function Base.map!(f::typeof(identity), dest::KroneckerEye, src::KroneckerEye)
map!(f, dest.a, src.a)
return dest
end
function Base.map!(::typeof(identity), dest::EyeEye, src::EyeEye)
return error("Can't write in-place.")
end
for f in [:+, :-]
@eval begin
function Base.map!(::typeof($f), dest::EyeKronecker, a::EyeKronecker, b::EyeKronecker)
if dest.a ≠ a.a ≠ b.a
throw(
ArgumentError(
"KroneckerArray addition is only supported when the first or second arguments match.",
),
)
end
map!($f, dest.b, a.b, b.b)
return dest
end
function Base.map!(::typeof($f), dest::KroneckerEye, a::KroneckerEye, b::KroneckerEye)
if dest.b ≠ a.b ≠ b.b
throw(
ArgumentError(
"KroneckerArray addition is only supported when the first or second arguments match.",
),
)
end
map!($f, dest.a, a.a, b.a)
return dest
end
function Base.map!(::typeof($f), dest::EyeEye, a::EyeEye, b::EyeEye)
return error("Can't write in-place.")
end
end
end
function Base.map!(f::typeof(-), dest::EyeKronecker, a::EyeKronecker)
map!(f, dest.b, a.b)
return dest
end
function Base.map!(f::typeof(-), dest::KroneckerEye, a::KroneckerEye)
map!(f, dest.a, a.a)
return dest
end
function Base.map!(f::typeof(-), dest::EyeEye, a::EyeEye)
return error("Can't write in-place.")
end
function Base.map!(f::Base.Fix1{typeof(*),<:Number}, dest::EyeKronecker, a::EyeKronecker)
map!(f, dest.b, a.b)
return dest
end
function Base.map!(f::Base.Fix1{typeof(*),<:Number}, dest::KroneckerEye, a::KroneckerEye)
map!(f, dest.a, a.a)
return dest
end
function Base.map!(f::Base.Fix1{typeof(*),<:Number}, dest::EyeEye, a::EyeEye)
return error("Can't write in-place.")
end
function Base.map!(f::Base.Fix2{typeof(*),<:Number}, dest::EyeKronecker, a::EyeKronecker)
map!(f, dest.b, a.b)
return dest
end
function Base.map!(f::Base.Fix2{typeof(*),<:Number}, dest::KroneckerEye, a::KroneckerEye)
map!(f, dest.a, a.a)
return dest
end
function Base.map!(f::Base.Fix2{typeof(*),<:Number}, dest::EyeEye, a::EyeEye)
return error("Can't write in-place.")
end

using Base.Broadcast:
AbstractArrayStyle, AbstractArrayStyle, BroadcastStyle, Broadcasted, broadcasted

Expand All @@ -233,3 +95,82 @@ Base.BroadcastStyle(style1::EyeStyle, style2::DefaultArrayStyle) = style2
function Base.similar(bc::Broadcasted{EyeStyle}, elt::Type)
return Eye{elt}(axes(bc))
end

function Base.copyto!(dest::EyeKronecker, a::Sum{<:KroneckerStyle{<:Any,EyeStyle()}})
dest2 = arg2(dest)
f = LinearCombination(a)
args = arguments(a)
arg2s = arg2.(args)
dest2 .= f.(arg2s...)
return dest
end
function Base.copyto!(dest::KroneckerEye, a::Sum{<:KroneckerStyle{<:Any,<:Any,EyeStyle()}})
dest1 = arg1(dest)
f = LinearCombination(a)
args = arguments(a)
arg1s = arg1.(args)
dest1 .= f.(arg1s...)
return dest
end
function Base.copyto!(dest::EyeEye, a::Sum{<:KroneckerStyle{<:Any,EyeStyle(),EyeStyle()}})
return error("Can't write in-place to `Eye ⊗ Eye`.")
end

# Simplification rules similar to those for FillArrays.jl:
# https://github.com/JuliaArrays/FillArrays.jl/blob/v1.13.0/src/fillbroadcast.jl
using FillArrays: Zeros
function Base.broadcasted(
style::KroneckerStyle,
::typeof(+),
a::KroneckerArray,
b::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
)
# TODO: Promote the element types.
return a
end
function Base.broadcasted(
style::KroneckerStyle,
::typeof(+),
a::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
b::KroneckerArray,
)
# TODO: Promote the element types.
return b
end
function Base.broadcasted(
style::KroneckerStyle,
::typeof(+),
a::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
b::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
)
# TODO: Promote the element types and axes.
return b
end
function Base.broadcasted(
style::KroneckerStyle,
::typeof(-),
a::KroneckerArray,
b::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
)
# TODO: Promote the element types.
return a
end
function Base.broadcasted(
style::KroneckerStyle,
::typeof(-),
a::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
b::KroneckerArray,
)
# TODO: Promote the element types.
# TODO: Return `broadcasted(-, b)`.
return -b
end
function Base.broadcasted(
style::KroneckerStyle,
::typeof(-),
a::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
b::KroneckerArray{<:Any,<:Any,<:Zeros,<:Zeros},
)
# TODO: Promote the element types and axes.
return b
end
Loading
Loading