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

entropy with isprobvec check #865

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
27 changes: 16 additions & 11 deletions src/scalarstats.jl
Original file line number Diff line number Diff line change
Expand Up @@ -726,21 +726,26 @@ zscore(X::AbstractArray{<:Real}, dim::Int) = ((μ, σ) = mean_and_std(X, dim); z
#############################

"""
entropy(p, [b])
isprobvec(p::AbstractVector{<:Real}) -> Bool

Checks whether `p` is a probability vector, i.e. p[i] >= 0 for each index i, and sum(p) ≈ 1.
Taken from `Distributions.isprobvec`."""
isprobvec(p::AbstractVector{<:Real}) = all(x -> x ≥ zero(x), p) && isapprox(sum(p), one(eltype(p)))
Copy link
Member

Choose a reason for hiding this comment

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

It would be nice to support tolerances here due to floating point inaccuracies but I don't see a nice way to forward them to this function.


"""
entropy(p::AbstractVector{<:Real}, [b]; check::Bool=true)

Compute the entropy of a collection of probabilities `p`,
optionally specifying a real number `b` such that the entropy is scaled by `1/log(b)`.
Elements with probability 0 or 1 add 0 to the entropy.
"""
function entropy(p)
if isempty(p)
throw(ArgumentError("empty collections are not supported since they do not " *
"represent proper probability distributions"))
end
return -sum(xlogx, p)
end

entropy(p, b::Real) = entropy(p) / log(b)
With `check=false` disable a check whether `p` is indeed a probability vector,
see `StatsBase.isprobvec`."""
function entropy(p::AbstractVector{<:Real}; check::Bool = true)
check && (isprobvec(p) || throw(ArgumentError("Not a proper probability distribution")))
return -sum(xlogx, p)
end

entropy(p, b::Real; check::Bool = true) = entropy(p; check) / log(b)
Copy link
Member

Choose a reason for hiding this comment

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

Should we check b as well? In any case, we need

Suggested change
entropy(p, b::Real; check::Bool = true) = entropy(p; check) / log(b)
entropy(p, b::Real; check::Bool = true) = entropy(p; check = check) / log(b)


"""
renyientropy(p, α)
Expand Down