Skip to content

Remove unnecessary rule for hvcat_fill! #3490

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
wsmoses merged 1 commit into from
Sep 1, 2026
Merged

Remove unnecessary rule for hvcat_fill! #3490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
108 changes: 55 additions & 53 deletions src/internal_rules/core.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,66 +486,68 @@ function EnzymeRules.reverse(
return ntuple(Returns(nothing), Val(2 + length(args)))
end

# Force a rule around hvcat_fill as it is type unstable if the tuple is not of the same type (e.g., int, float, int, float)
function EnzymeRules.augmented_primal(
config::EnzymeRules.RevConfig,
func::Const{typeof(Base.hvcat_fill!)},
::Type{RT},
out::Annotation{AT},
inp::Annotation{BT},
) where {RT,AT<:Array,BT<:Tuple}
primal = if EnzymeRules.needs_primal(config)
out.val
else
nothing
end
shadow = if EnzymeRules.needs_shadow(config)
out.dval
else
nothing
end
func.val(out.val, inp.val)
return EnzymeRules.AugmentedReturn(primal, shadow, nothing)
end

function EnzymeRules.reverse(
config::EnzymeRules.RevConfig,
func::Const{typeof(Base.hvcat_fill!)},
::Type{RT},
_,
out::Annotation{AT},
inp::Annotation{BT},
) where {RT,AT<:Array,BT<:Tuple}
nr, nc = size(out.val, 1), size(out.val, 2)
for b = 1:EnzymeRules.width(config)
da = if EnzymeRules.width(config) == 1
if isdefined(Base, :hvcat_fill!)
# Force a rule around hvcat_fill as it is type unstable if the tuple is not of the same type (e.g., int, float, int, float)
function EnzymeRules.augmented_primal(
config::EnzymeRules.RevConfig,
func::Const{typeof(Base.hvcat_fill!)},
::Type{RT},
out::Annotation{AT},
inp::Annotation{BT},
) where {RT,AT<:Array,BT<:Tuple}
primal = if EnzymeRules.needs_primal(config)
out.val
else
nothing
end
shadow = if EnzymeRules.needs_shadow(config)
out.dval
else
out.dval[b]
nothing
end
i = 1
j = 1
if (typeof(inp) <: Active)
dinp = ntuple(Val(length(inp.val))) do k
Base.@_inline_meta
res = da[i, j]
da[i, j] = 0
j += 1
if j == nc + 1
i += 1
j = 1
end
T = BT.parameters[k]
if T <: AbstractFloat
T(res)
else
T(0)
func.val(out.val, inp.val)
return EnzymeRules.AugmentedReturn(primal, shadow, nothing)
end

function EnzymeRules.reverse(
config::EnzymeRules.RevConfig,
func::Const{typeof(Base.hvcat_fill!)},
::Type{RT},
_,
out::Annotation{AT},
inp::Annotation{BT},
) where {RT,AT<:Array,BT<:Tuple}
nr, nc = size(out.val, 1), size(out.val, 2)
for b = 1:EnzymeRules.width(config)
da = if EnzymeRules.width(config) == 1
out.dval
else
out.dval[b]
end
i = 1
j = 1
if (typeof(inp) <: Active)
dinp = ntuple(Val(length(inp.val))) do k
Base.@_inline_meta
res = da[i, j]
da[i, j] = 0
j += 1
if j == nc + 1
i += 1
j = 1
end
T = BT.parameters[k]
if T <: AbstractFloat
T(res)
else
T(0)
end
end
return (nothing, dinp)::Tuple{Nothing,BT}
end
return (nothing, dinp)::Tuple{Nothing,BT}
end
return (nothing, nothing)
end
return (nothing, nothing)
end

function EnzymeRules.forward(config, ::Const{typeof(Base.finalizer)}, _, f::Const, o)
Expand Down
24 changes: 13 additions & 11 deletions test/basic.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,17 +618,19 @@ end
end

@testset "hvcat_fill" begin
ar = Matrix{Float64}(undef, 2, 3)
dar = [1.0 2.0 3.0; 4.0 5.0 6.0]

res = first(Enzyme.autodiff(Reverse, Base.hvcat_fill!, Const, Duplicated(ar, dar), Active((1, 2.2, 3, 4.4, 5, 6.6))))

@test res[2][1] == 0
@test res[2][2] ≈ 2.0
@test res[2][3] ≈ 0
@test res[2][4] ≈ 4.0
@test res[2][5] ≈ 0
@test res[2][6] ≈ 6.0
if isdefined(Base, :hvcat_fill!)
ar = Matrix{Float64}(undef, 2, 3)
dar = [1.0 2.0 3.0; 4.0 5.0 6.0]

res = first(Enzyme.autodiff(Reverse, Base.hvcat_fill!, Const, Duplicated(ar, dar), Active((1, 2.2, 3, 4.4, 5, 6.6))))

@test res[2][1] == 0
@test res[2][2] ≈ 2.0
@test res[2][3] ≈ 0
@test res[2][4] ≈ 4.0
@test res[2][5] ≈ 0
@test res[2][6] ≈ 6.0
end
end

function named_deepcopy(x, nt)
Expand Down
Loading