shannon_entropy

shannon_entropy(pvec, base=2)[source]

Compute the Shannon entropy of a probability vector.

The shannon entropy of a probability vector pv is defined as $H(pv) = - sum_j pv[j] log_b (pv[j])$ where $0 log_b 0 = 0$.

Parameters
  • pvec (array_like) – a probability vector.

  • base (int) – the base of the logarithm

Returns

The Shannon entropy H(pvec).

Return type

float