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

Jump to bottom

Disallow ceil/trunc/floor on complex arguments #51141

Closed
wants to merge 2 commits into from
Closed

Disallow ceil/trunc/floor on complex arguments #51141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10599b1
Disallow ceil/trunc/floor on complex arguments
Seelengrab Sep 1, 2023
224df17
Fix ambiguity with `missing` in rounding
Seelengrab Sep 3, 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
19 changes: 17 additions & 2 deletions base/complex.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1084,9 +1084,10 @@ breaking ties using the specified [`RoundingMode`](@ref)s. The first
second is used for rounding the imaginary components.


`RoundingModeReal` and `RoundingModeImaginary` default to [`RoundNearest`](@ref),
`RoundingModeReal` defaults to [`RoundNearest`](@ref),
which rounds to the nearest integer, with ties (fractional values of 0.5)
being rounded to the nearest even integer.
being rounded to the nearest even integer. `RoundingModeImaginary` defaults to
the mode `RoundingModeReal` is set to.

# Example
```jldoctest
Expand All @@ -1108,6 +1109,20 @@ function round(z::Complex, rr::RoundingMode=RoundNearest, ri::RoundingMode=rr; k
round(imag(z), ri; kwargs...))
end

trunc(x::Complex; kws...) = throw_complex_round(trunc, (typeof(x),))
floor(x::Complex; kws...) = throw_complex_round(floor, (typeof(x),))
ceil(x::Complex; kws...) = throw_complex_round( ceil, (typeof(x),))

trunc(::Type{T}, x::Complex) where T = throw_complex_round(trunc, (T, typeof(x)))
floor(::Type{T}, x::Complex) where T = throw_complex_round(floor, (T, typeof(x)))
ceil(::Type{T}, x::Complex) where T = throw_complex_round( ceil, (T, typeof(x)))
round(::Type{T}, x::Complex) where T = throw_complex_round(round, (T, typeof(x)))

@noinline function throw_complex_round(f, args)
argstr = join(args, ", ::")
str = "`$f(::$argstr)` is not defined - use `round` and specify rounding modes for the real & complex parts instead."
throw(DomainError(str))
end

float(z::Complex{<:AbstractFloat}) = z
float(z::Complex) = Complex(float(real(z)), float(imag(z)))
Expand Down
1 change: 1 addition & 0 deletions base/missing.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ round(::Type{T}, x::Any, r::RoundingMode=RoundNearest) where {T>:Missing} = roun
round(::Type{T}, x::Real, r::RoundingMode=RoundNearest) where {T>:Missing} = round(nonmissingtype_checked(T), x, r)
round(::Type{T}, x::Rational{Tr}, r::RoundingMode=RoundNearest) where {T>:Missing,Tr} = round(nonmissingtype_checked(T), x, r)
round(::Type{T}, x::Rational{Bool}, r::RoundingMode=RoundNearest) where {T>:Missing} = round(nonmissingtype_checked(T), x, r)
round(::Type{T}, x::Complex, rr::RoundingMode=RoundNearest, ri::RoundingMode=rr) where {T>:Missing} = round(nonmissingtype_checked(T), x, rr, ri)

# to avoid ambiguity warnings
(^)(::Missing, ::Integer) = missing
Expand Down
16 changes: 8 additions & 8 deletions test/rounding.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,18 +361,18 @@ end

@testset "rounding complex numbers (#42060, #47128)" begin
# 42060
@test ceil(Complex(4.6, 2.2)) === Complex(5.0, 3.0)
@test floor(Complex(4.6, 2.2)) === Complex(4.0, 2.0)
@test trunc(Complex(4.6, 2.2)) === Complex(4.0, 2.0)
@test_throws DomainError ceil(Complex(4.6, 2.2))
@test_throws DomainError floor(Complex(4.6, 2.2))
@test_throws DomainError trunc(Complex(4.6, 2.2))
@test_throws DomainError ceil(Complex(-4.6, -2.2))
@test_throws DomainError floor(Complex(-4.6, -2.2))
@test_throws DomainError trunc(Complex(-4.6, -2.2))
@test round(Complex(4.6, 2.2)) === Complex(5.0, 2.0)
@test ceil(Complex(-4.6, -2.2)) === Complex(-4.0, -2.0)
@test floor(Complex(-4.6, -2.2)) === Complex(-5.0, -3.0)
@test trunc(Complex(-4.6, -2.2)) === Complex(-4.0, -2.0)
@test round(Complex(-4.6, -2.2)) === Complex(-5.0, -2.0)

# 47128
@test round(Complex{Int}, Complex(4.6, 2.2)) === Complex(5, 2)
@test ceil(Complex{Int}, Complex(4.6, 2.2)) === Complex(5, 3)
@test_throws DomainError round(Complex{Int}, Complex(4.6, 2.2)) === Complex(5, 2)
@test_throws DomainError ceil(Complex{Int}, Complex(4.6, 2.2)) === Complex(5, 3)
end

@testset "rounding to custom integers" begin
Expand Down