Skip to content

Added zero, iszero, one, isone to dual #74

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.

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/DualNumbers.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ module DualNumbers
using SpecialFunctions
import NaNMath
import Calculus
import Random

include("dual.jl")

Expand Down
31 changes: 23 additions & 8 deletions src/dual.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const DualComplex64 = Dual{ComplexF16}
Base.convert(::Type{Dual{T}}, z::Dual{T}) where {T<:ReComp} = z
Base.convert(::Type{Dual{T}}, z::Dual) where {T<:ReComp} = Dual{T}(convert(T, value(z)), convert(T, epsilon(z)))
Base.convert(::Type{Dual{T}}, x::Number) where {T<:ReComp} = Dual{T}(convert(T, x), convert(T, 0))
Base.convert(::Type{T}, z::Dual) where {T<:ReComp} = (epsilon(z)==0 ? convert(T, value(z)) : throw(InexactError()))
Base.convert(::Type{T}, z::Dual) where {T<:ReComp} = (iszero(epsilon(z)) ? convert(T, value(z)) : throw(InexactError()))

Base.promote_rule(::Type{Dual{T}}, ::Type{Dual{S}}) where {T<:ReComp,S<:ReComp} = Dual{promote_type(T, S)}
Base.promote_rule(::Type{Dual{T}}, ::Type{S}) where {T<:ReComp,S<:ReComp} = Dual{promote_type(T, S)}
Expand Down Expand Up @@ -175,7 +175,7 @@ Base.isless(z::Dual{<:Real},w::Dual{<:Real}) = value(z) < value(w)
Base.isless(z::Real,w::Dual{<:Real}) = z < value(w)
Base.isless(z::Dual{<:Real},w::Real) = value(z) < w

Base.hash(z::Dual) = (x = hash(value(z)); epsilon(z)==0 ? x : bitmix(x,hash(epsilon(z))))
Base.hash(z::Dual) = (x = hash(value(z)); iszero(epsilon(z)) ? x : bitmix(x,hash(epsilon(z))))

Base.float(z::Union{Dual{T}, Dual{Complex{T}}}) where {T<:AbstractFloat} = z
Base.complex(z::Dual{<:Complex}) = z
Expand All @@ -189,6 +189,21 @@ Base.ceil( ::Type{T}, z::Dual) where {T<:Real} = ceil( T, value(z))
Base.trunc(::Type{T}, z::Dual) where {T<:Real} = trunc(T, value(z))
Base.round(::Type{T}, z::Dual) where {T<:Real} = round(T, value(z))

Base.zero(::Type{Dual{T}}) where {T} = Dual(zero(T), zero(T))
Base.zero(x::Dual{T}) where {T} = zero(typeof(x))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not

Suggested change
Base.zero(x::Dual{T}) where {T} = zero(typeof(x))
Base.zero(::Dual{T}) where {T} = zero(Dual{T})

Base.iszero(z::Dual{T}) where {T} = iszero(value(z))

Base.one(::Type{Dual{T}}) where {T} = Dual(one(T), zero(T))
Base.one(::Dual{T}) where {T} = one(Dual{T})
Base.isone(z::Dual{T}) where {T} = isone(value(z))

Base.rand(r::Random.AbstractRNG, ::Random.SamplerType{Dual{T}}) where {T} = Dual{T}(rand(r, T), rand(r, T))
Base.randn(r::Random.AbstractRNG, ::Type{Dual{T}}) where {T} = Dual{T}(randn(r, T), randn(r, T))

Base.rtoldefault(::Type{Dual{T}}) where {T} = Base.rtoldefault(T)
Base.copysign(x::Dual, y::Dual) = Dual(copysign(value(x), value(y)),
copysign(epsilon(x), epsilon(y)))

for op in (:real, :imag, :conj, :float, :complex)
@eval Base.$op(z::Dual) = Dual($op(value(z)), $op(epsilon(z)))
end
Expand All @@ -201,8 +216,8 @@ Base.abs(z::Dual{<:Real}) = z ≥ 0 ? z : -z

Base.angle(z::Dual{<:Real}) = z ≥ 0 ? zero(z) : one(z)*π
function Base.angle(z::Dual{Complex{T}}) where T<:Real
if z == 0
if imag(epsilon(z)) == 0
if iszero(z)
if iszero(imag(epsilon(z)))
Dual(zero(T), zero(T))
else
Dual(zero(T), convert(T, Inf))
Expand All @@ -212,8 +227,8 @@ function Base.angle(z::Dual{Complex{T}}) where T<:Real
end
end

Base.flipsign(x::Dual,y::Dual) = y == 0 ? flipsign(x, epsilon(y)) : flipsign(x, value(y))
Base.flipsign(x, y::Dual) = y == 0 ? flipsign(x, epsilon(y)) : flipsign(x, value(y))
Base.flipsign(x::Dual,y::Dual) = iszero(y) ? flipsign(x, epsilon(y)) : flipsign(x, value(y))
Base.flipsign(x, y::Dual) = iszero(y) ? flipsign(x, epsilon(y)) : flipsign(x, value(y))
Base.flipsign(x::Dual, y) = dual(flipsign(value(x), y), flipsign(epsilon(x), y))

# algebraic definitions
Expand All @@ -233,7 +248,7 @@ Base.:-(z::Number, w::Dual) = Dual(z-value(w), -epsilon(w))
Base.:-(z::Dual, w::Number) = Dual(value(z)-w, epsilon(z))

# avoid ambiguous definition with Bool*Number
Base.:*(x::Bool, z::Dual) = ifelse(x, z, ifelse(signbit(real(value(z)))==0, zero(z), -zero(z)))
Base.:*(x::Bool, z::Dual) = ifelse(x, z, ifelse(iszero(signbit(real(value(z)))), zero(z), -zero(z)))
Base.:*(x::Dual, z::Bool) = z*x

Base.:*(z::Dual, w::Dual) = Dual(value(z)*value(w), epsilon(z)*value(w)+value(z)*epsilon(w))
Expand All @@ -246,7 +261,7 @@ Base.:/(z::Dual, x::Number) = Dual(value(z)/x, epsilon(z)/x)

for f in [:(Base.:^), :(NaNMath.pow)]
@eval function ($f)(z::Dual, w::Dual)
if epsilon(w) == 0.0
if iszero(epsilon(w))
return $f(z, value(w))
end
val = $f(value(z), value(w))
Expand Down
10 changes: 10 additions & 0 deletions test/automatic_differentiation_test.jl
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ z = Dual(1.0+1.0im,cis(π/4))
z = Dual(1.0+1.0im,cis(π/2))
@test abs(z) ≡ sqrt(2) + 1/sqrt(2)*ɛ


# tests vectorized methods
const zv = dual.(collect(1.0:10.0), ones(10))

Expand Down Expand Up @@ -173,3 +174,12 @@ end

@test value(3) == 3
@test epsilon(44.0) ≈ 0.0

@test one(Dual{Float64}) == Dual(1,0)
@test isone(Dual(1,0))
@test isone(one(rand(Dual{Float64})))

@test zero(Dual{Float64}) == Dual(0,0)
@test iszero(Dual(0,0))

@test copysign(Dual(-1,-2), Dual(2,3)) == Dual(1,2)