Remove mlab.entropy

dstansby · dstansby · commit d7768265123a · 2018-09-19T17:58:43.000+01:00
diff --git a/doc/api/next_api_changes/2018-09-18-DS.rst b/doc/api/next_api_changes/2018-09-18-DS.rst
@@ -6,4 +6,5 @@ in Matplotlib 2.2 has been removed. See below for a list:
 
 - `mlab.logspace` (use numpy.logspace instead)
 - `mlab.cohere_pairs` (use scipy.signal.coherence instead)
+- `mlab.entropy` (use scipy.stats.entropy instead)
 - `mlab.donothing_callback`
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -1194,36 +1194,6 @@ def cohere(x, y, NFFT=256, Fs=2, detrend=detrend_none, window=window_hanning,
     return Cxy, f
 
 
-@cbook.deprecated('2.2', 'scipy.stats.entropy')
-def entropy(y, bins):
-    r"""
-    Return the entropy of the data in *y* in units of nat.
-
-    .. math::
-
-      -\sum p_i \ln(p_i)
-
-    where :math:`p_i` is the probability of observing *y* in the
-    :math:`i^{th}` bin of *bins*.  *bins* can be a number of bins or a
-    range of bins; see :func:`numpy.histogram`.
-
-    Compare *S* with analytic calculation for a Gaussian::
-
-      x = mu + sigma * randn(200000)
-      Sanalytic = 0.5 * ( 1.0 + log(2*pi*sigma**2.0) )
-    """
-    n, bins = np.histogram(y, bins)
-    n = n.astype(float)
-
-    n = np.take(n, np.nonzero(n)[0])         # get the positive
-
-    p = np.divide(n, len(y))
-
-    delta = bins[1] - bins[0]
-    S = -1.0 * np.sum(p * np.log(p)) + np.log(delta)
-    return S
-
-
 @cbook.deprecated('2.2', 'scipy.stats.norm.pdf')
 def normpdf(x, *args):
     "Return the normal pdf evaluated at *x*; args provides *mu*, *sigma*"
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -233,7 +233,7 @@
 from matplotlib.mlab import (
     amap, base_repr, binary_repr, bivariate_normal, center_matrix, csv2rec,
     demean, detrend, detrend_linear, detrend_mean, detrend_none, dist,
-    dist_point_to_segment, distances_along_curve, entropy, exp_safe,
+    dist_point_to_segment, distances_along_curve, exp_safe,
     fftsurr, find, frange, get_sparse_matrix, get_xyz_where, griddata,
     identity, inside_poly, is_closed_polygon, ispower2, isvector, l1norm,
     l2norm, log2, longest_contiguous_ones, longest_ones, movavg, norm_flat,
