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.

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

Deprecate factorial(::Measurement) #111

Merged
merged 1 commit into from
Dec 14, 2021
Merged
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
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
([#103](https://github.com/JuliaPhysics/Measurements.jl/issues/103),
[#104](https://github.com/JuliaPhysics/Measurements.jl/pull/104)).

### Deprecations

* `factorial(a::Measurement)` is deprecated in favour of
`SpecialFunctions.gamma(a + 1)`, as a result of
`SpecialFunctions.factorial(a::AbstractFloat)` being removed in
`SpecialFunctions.jl` v2.0
([#111](https://github.com/JuliaPhysics/Measurements.jl/pull/111)).

## v2.6.0 (2021-04-20)

### New features
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "Measurements"
uuid = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
authors = ["Mosè Giordano <mose@gnu.org>"]
version = "2.6.0"
version = "2.7.0"

[deps]
Calculus = "49dc2e85-a5d0-5ad3-a950-438e2897f1b9"
Expand Down
18 changes: 11 additions & 7 deletions src/special-functions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,7 @@ function SpecialFunctions.dawson(a::Measurement{T}) where {T<:AbstractFloat}
return result(res, one(T) - 2 * aval * res, a)
end

# Factorial and gamma

function SpecialFunctions.factorial(a::Measurement)
aval = a.val
fact = SpecialFunctions.factorial(aval)
return result(fact, fact*digamma(aval + one(aval)), a)
end
# Gamma

function SpecialFunctions.gamma(a::Measurement)
aval = a.val
Expand Down Expand Up @@ -226,3 +220,13 @@ function SpecialFunctions.besselkx(nu::Real, a::Measurement)
besselk(nu, x)*exp(x),
a)
end

# Deprecations
function Base.factorial(a::Measurement)
Base.depwarn("""
factorial(($(a))::Measurement) is deprecated, instead use
SpecialFunctions.gamma($(a + one(a)))
""",
:factorial)
SpecialFunctions.gamma(a + one(a))
end