H: Shannon's Entropy H(X)
In philentropy: Similarity and Distance Quantification Between Probability Functions
H R Documentation
Shannon's Entropy H(X)
Description
Compute the Shannon's Entropy H(X) = - ∑ P(X) * log2(P(X)) based on a
given probability vector P(X).
Usage
H(x, unit = "log2")
Arguments
x
a numeric probability vector P(X) for which
Shannon's Entropy H(X) shall be computed.
unit
a character string specifying the logarithm unit that shall be used to compute distances that depend on log computations.
Details
This function might be useful to fastly compute Shannon's Entropy for any
given probability vector.
Value
a numeric value representing Shannon's Entropy in bit.
Author(s)
Hajk-Georg Drost
References
Shannon, Claude E. 1948. "A Mathematical Theory of
Communication". Bell System Technical Journal 27 (3): 379-423.
See Also
JE, CE, KL, JSD, gJSD
Examples
H(1:10/sum(1:10))
philentropy documentation built on Nov. 10, 2022, 6:18 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| H | R Documentation |
Shannon's Entropy H(X)
Description
Compute the Shannon's Entropy H(X) = - ∑ P(X) * log2(P(X)) based on a given probability vector P(X).
Usage
H(x, unit = "log2")
Arguments
x |
a numeric probability vector P(X) for which Shannon's Entropy H(X) shall be computed. |
unit |
a character string specifying the logarithm unit that shall be used to compute distances that depend on log computations. |
Details
This function might be useful to fastly compute Shannon's Entropy for any given probability vector.
Value
a numeric value representing Shannon's Entropy in bit.
Author(s)
Hajk-Georg Drost
References
Shannon, Claude E. 1948. "A Mathematical Theory of Communication". Bell System Technical Journal 27 (3): 379-423.
See Also
JE, CE, KL, JSD, gJSD
Examples
H(1:10/sum(1:10))
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.