Remove mlab.frange

dstansby · dstansby · commit 00cace4744d8 · 2018-09-29T11:05:09.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
@@ -11,6 +11,7 @@ in Matplotlib 2.2 has been removed. See below for a list:
 - `mlab.l1norm` (use ``numpy.linalg.norm(a, ord=1)`` instead)
 - `mlab.l2norm` (use ``numpy.linalg.norm(a, ord=2)`` instead)
 - `mlab.norm_flat` (use ``numpy.linalg.norm(a.flat, ord=2)`` instead)
+- `mlab.frange` (use numpy.arange instead)
 - `mlab.cohere_pairs` (use scipy.signal.coherence instead)
 - `mlab.entropy` (use scipy.stats.entropy instead)
 - `mlab.normpdf` (use scipy.stats.norm.pdf instead)
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -1247,74 +1247,6 @@ def movavg(x, n):
 """
 
 
-@cbook.deprecated("2.2", 'numpy.arange')
-def frange(xini, xfin=None, delta=None, **kw):
-    """
-    frange([start,] stop[, step, keywords]) -> array of floats
-
-    Return a numpy ndarray containing a progression of floats. Similar to
-    :func:`numpy.arange`, but defaults to a closed interval.
-
-    ``frange(x0, x1)`` returns ``[x0, x0+1, x0+2, ..., x1]``; *start*
-    defaults to 0, and the endpoint *is included*. This behavior is
-    different from that of :func:`range` and
-    :func:`numpy.arange`. This is deliberate, since :func:`frange`
-    will probably be more useful for generating lists of points for
-    function evaluation, and endpoints are often desired in this
-    use. The usual behavior of :func:`range` can be obtained by
-    setting the keyword *closed* = 0, in this case, :func:`frange`
-    basically becomes :func:numpy.arange`.
-
-    When *step* is given, it specifies the increment (or
-    decrement). All arguments can be floating point numbers.
-
-    ``frange(x0,x1,d)`` returns ``[x0,x0+d,x0+2d,...,xfin]`` where
-    *xfin* <= *x1*.
-
-    :func:`frange` can also be called with the keyword *npts*. This
-    sets the number of points the list should contain (and overrides
-    the value *step* might have been given). :func:`numpy.arange`
-    doesn't offer this option.
-
-    Examples::
-
-      >>> frange(3)
-      array([ 0.,  1.,  2.,  3.])
-      >>> frange(3,closed=0)
-      array([ 0.,  1.,  2.])
-      >>> frange(1,6,2)
-      array([1, 3, 5])   or 1,3,5,7, depending on floating point vagueries
-      >>> frange(1,6.5,npts=5)
-      array([ 1.   ,  2.375,  3.75 ,  5.125,  6.5  ])
-    """
-
-    # defaults
-    kw.setdefault('closed', 1)
-    endpoint = kw['closed'] != 0
-
-    # funny logic to allow the *first* argument to be optional (like range())
-    # This was modified with a simpler version from a similar frange() found
-    # at http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66472
-    if xfin is None:
-        xfin = xini + 0.0
-        xini = 0.0
-
-    if delta is None:
-        delta = 1.0
-
-    # compute # of points, spacing and return final list
-    try:
-        npts = kw['npts']
-        delta = (xfin-xini) / (npts-endpoint)
-    except KeyError:
-        npts = int(np.round((xfin-xini)/delta)) + endpoint
-        # round finds the nearest, so the endpoint can be up to
-        # delta/2 larger than xfin.
-
-    return np.arange(npts)*delta+xini
-# end frange()
-
-
 @cbook.deprecated("2.2", 'numpy.identity')
 def identity(n, rank=2, dtype='l', typecode=None):
     """
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -231,7 +231,6 @@
 from matplotlib.mlab import (
     base_repr, binary_repr, csv2rec,
     demean, detrend, detrend_linear, detrend_mean, detrend_none,
-    frange,
     identity, ispower2, isvector,
     log2, movavg,
     window_hanning, window_none)
