Skip to content
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

make one(::Dual) return underlying Real type #664

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

make one(::Dual) return underlying Real type #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ed190d
make one(::Dual) return underlying Real type
stevengj Sep 18, 2023
0605f9e
Update DualTest.jl
stevengj Sep 18, 2023
48a484e
Update DualTest.jl
stevengj Sep 18, 2023
159b95a
Update partials.jl
stevengj Sep 18, 2023
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
4 changes: 3 additions & 1 deletion src/dual.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,9 @@ end
@inline Base.zero(::Type{Dual{T,V,N}}) where {T,V,N} = Dual{T}(zero(V), zero(Partials{N,V}))

@inline Base.one(d::Dual) = one(typeof(d))
@inline Base.one(::Type{Dual{T,V,N}}) where {T,V,N} = Dual{T}(one(V), zero(Partials{N,V}))
@inline Base.oneunit(d::Dual) = oneunit(typeof(d))
@inline Base.one(::Type{Dual{T,V,N}}) where {T,V,N} = one(V)
@inline Base.oneunit(::Type{Dual{T,V,N}}) where {T,V,N} = Dual{T}(oneunit(V), zero(Partials{N,V}))

@inline function Base.Int(d::Dual)
all(iszero, partials(d)) || throw(InexactError(:Int, Int, d))
Expand Down
2 changes: 1 addition & 1 deletion src/partials.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ end
##############################

@generated function single_seed(::Type{Partials{N,V}}, ::Val{i}) where {N,V,i}
ex = Expr(:tuple, [ifelse(i === j, :(one(V)), :(zero(V))) for j in 1:N]...)
ex = Expr(:tuple, [ifelse(i === j, :(oneunit(V)), :(zero(V))) for j in 1:N]...)
return :(Partials($(ex)))
end

Expand Down
27 changes: 16 additions & 11 deletions test/DualTest.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,15 @@ ForwardDiff.:≺(::Type{OuterTestTag}, ::Type{TestTag}) = false
@test zero(NESTED_FDNUM) === Dual{TestTag()}(Dual{TestTag()}(zero(PRIMAL), zero(M_PARTIALS)), zero(NESTED_PARTIALS))
@test zero(typeof(NESTED_FDNUM)) === Dual{TestTag()}(Dual{TestTag()}(zero(V), zero(Partials{M,V})), zero(Partials{N,Dual{TestTag(),V,M}}))

@test one(FDNUM) === Dual{TestTag()}(one(PRIMAL), zero(PARTIALS))
@test one(typeof(FDNUM)) === Dual{TestTag()}(one(V), zero(Partials{N,V}))
@test one(NESTED_FDNUM) === Dual{TestTag()}(Dual{TestTag()}(one(PRIMAL), zero(M_PARTIALS)), zero(NESTED_PARTIALS))
@test one(typeof(NESTED_FDNUM)) === Dual{TestTag()}(Dual{TestTag()}(one(V), zero(Partials{M,V})), zero(Partials{N,Dual{TestTag(),V,M}}))
@test one(FDNUM) === one(value(FDNUM))
@test one(typeof(FDNUM)) === one(typeof(value(FDNUM)))
@test one(NESTED_FDNUM) === one(value(NESTED_FDNUM))
@test one(typeof(NESTED_FDNUM)) === one(typeof(value(NESTED_FDNUM)))

@test oneunit(FDNUM) === Dual{TestTag()}(one(PRIMAL), zero(PARTIALS))
@test oneunit(typeof(FDNUM)) === Dual{TestTag()}(one(V), zero(Partials{N,V}))
@test oneunit(NESTED_FDNUM) === Dual{TestTag()}(Dual{TestTag()}(one(PRIMAL), zero(M_PARTIALS)), zero(NESTED_PARTIALS))
@test oneunit(typeof(NESTED_FDNUM)) === Dual{TestTag()}(Dual{TestTag()}(one(V), zero(Partials{M,V})), zero(Partials{N,Dual{TestTag(),V,M}}))

if V <: Integer
@test rand(samerng(), FDNUM) == rand(samerng(), value(FDNUM))
Expand All @@ -233,11 +238,11 @@ ForwardDiff.:≺(::Type{OuterTestTag}, ::Type{TestTag}) = false
#------------#

@test ForwardDiff.isconstant(zero(FDNUM))
@test ForwardDiff.isconstant(one(FDNUM))
@test ForwardDiff.isconstant(oneunit(FDNUM))
@test ForwardDiff.isconstant(FDNUM) == (N == 0)

@test ForwardDiff.isconstant(zero(NESTED_FDNUM))
@test ForwardDiff.isconstant(one(NESTED_FDNUM))
@test ForwardDiff.isconstant(oneunit(NESTED_FDNUM))
@test ForwardDiff.isconstant(NESTED_FDNUM) == (N == 0)

# Recall that FDNUM = Dual{TestTag()}(PRIMAL, PARTIALS) has N partials,
Expand Down Expand Up @@ -476,15 +481,15 @@ ForwardDiff.:≺(::Type{OuterTestTag}, ::Type{TestTag}) = false
if arity == 1
deriv = DiffRules.diffrule(M, f, :x)
modifier = if in(f, (:asec, :acsc, :asecd, :acscd, :acosh, :acoth))
one(V)
oneunit(V)
elseif in(f, (:log1mexp, :log2mexp))
-one(V)
-oneunit(V)
else
zero(V)
end
@eval begin
x = rand() + $modifier
dx = @inferred $M.$f(Dual{TestTag()}(x, one(x)))
dx = @inferred $M.$f(Dual{TestTag()}(x, oneunit(x)))
actualval = $M.$f(x)
@assert actualval isa Real || actualval isa Complex
if actualval isa Real
Expand All @@ -510,8 +515,8 @@ ForwardDiff.:≺(::Type{OuterTestTag}, ::Type{TestTag}) = false
end
@eval begin
x, y = $x, $y
dx = @inferred $M.$f(Dual{TestTag()}(x, one(x)), y)
dy = @inferred $M.$f(x, Dual{TestTag()}(y, one(y)))
dx = @inferred $M.$f(Dual{TestTag()}(x, oneunit(x)), y)
dy = @inferred $M.$f(x, Dual{TestTag()}(y, oneunit(y)))
actualdx = $(derivs[1])
actualdy = $(derivs[2])
actualval = $M.$f(x, y)
Expand Down