Remove mlab deprecations.

QuLogic · QuLogic · commit 97c68642402e · 2020-09-18T20:27:33.000-04:00
diff --git a/doc/api/next_api_changes/removals/18522-ES.rst b/doc/api/next_api_changes/removals/18522-ES.rst
@@ -0,0 +1,3 @@
+``matplotlib.mlab``
+~~~~~~~~~~~~~~~~~~~
+``mlab.apply_window`` and ``mlab.stride_repeat`` have been removed.
diff --git a/doc/users/prev_whats_new/whats_new_1.4.rst b/doc/users/prev_whats_new/whats_new_1.4.rst
@@ -114,13 +114,13 @@ Support for detrending and windowing 2D arrays in mlab
 Todd Jennings added support for 2D arrays in the
 :func:`~matplotlib.mlab.detrend_mean`, :func:`~matplotlib.mlab.detrend_none`,
 and :func:`~matplotlib.mlab.detrend`, as well as adding
-:func:`~matplotlib.mlab.apply_window` which support windowing 2D arrays.
+``matplotlib.mlab.apply_window`` which support windowing 2D arrays.
 
 Support for strides in mlab
 ```````````````````````````
-Todd Jennings added some functions to mlab to make it easier to use numpy
+Todd Jennings added some functions to mlab to make it easier to use NumPy
 strides to create memory-efficient 2D arrays.  This includes
-:func:`~matplotlib.mlab.stride_repeat`, which repeats an array to create a 2D
+``matplotlib.mlab.stride_repeat``, which repeats an array to create a 2D
 array, and :func:`~matplotlib.mlab.stride_windows`, which uses a moving window
 to create a 2D array from a 1D array.
 
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -45,12 +45,6 @@
 
 `stride_windows`
     Get all windows in an array in a memory-efficient manner
-
-`stride_repeat`
-    Repeat an array in a memory-efficient manner
-
-`apply_window`
-    Apply a window along a given axis
 """
 
 import functools
@@ -85,63 +79,6 @@ def window_none(x):
     return x
 
 
-@cbook.deprecated("3.2")
-def apply_window(x, window, axis=0, return_window=None):
-    """
-    Apply the given window to the given 1D or 2D array along the given axis.
-
-    Parameters
-    ----------
-    x : 1D or 2D array or sequence
-        Array or sequence containing the data.
-
-    window : function or array.
-        Either a function to generate a window or an array with length
-        *x*.shape[*axis*]
-
-    axis : int
-        The axis over which to do the repetition.
-        Must be 0 or 1.  The default is 0
-
-    return_window : bool
-        If true, also return the 1D values of the window that was applied
-    """
-    x = np.asarray(x)
-
-    if x.ndim < 1 or x.ndim > 2:
-        raise ValueError('only 1D or 2D arrays can be used')
-    if axis+1 > x.ndim:
-        raise ValueError('axis(=%s) out of bounds' % axis)
-
-    xshape = list(x.shape)
-    xshapetarg = xshape.pop(axis)
-
-    if np.iterable(window):
-        if len(window) != xshapetarg:
-            raise ValueError('The len(window) must be the same as the shape '
-                             'of x for the chosen axis')
-        windowVals = window
-    else:
-        windowVals = window(np.ones(xshapetarg, dtype=x.dtype))
-
-    if x.ndim == 1:
-        if return_window:
-            return windowVals * x, windowVals
-        else:
-            return windowVals * x
-
-    xshapeother = xshape.pop()
-
-    otheraxis = (axis+1) % 2
-
-    windowValsRep = stride_repeat(windowVals, xshapeother, axis=otheraxis)
-
-    if return_window:
-        return windowValsRep * x, windowVals
-    else:
-        return windowValsRep * x
-
-
 def detrend(x, key=None, axis=None):
     """
     Return x with its trend removed.
@@ -343,62 +280,6 @@ def stride_windows(x, n, noverlap=None, axis=0):
     return np.lib.stride_tricks.as_strided(x, shape=shape, strides=strides)
 
 
-@cbook.deprecated("3.2")
-def stride_repeat(x, n, axis=0):
-    """
-    Repeat the values in an array in a memory-efficient manner.  Array x is
-    stacked vertically n times.
-
-    .. warning::
-
-        It is not safe to write to the output array.  Multiple
-        elements may point to the same piece of memory, so
-        modifying one value may change others.
-
-    Parameters
-    ----------
-    x : 1D array or sequence
-        Array or sequence containing the data.
-
-    n : int
-        The number of time to repeat the array.
-
-    axis : int
-        The axis along which the data will run.
-
-    References
-    ----------
-    `stackoverflow: Repeat NumPy array without replicating data?
-    <http://stackoverflow.com/a/5568169>`_
-    """
-    if axis not in [0, 1]:
-        raise ValueError('axis must be 0 or 1')
-    x = np.asarray(x)
-    if x.ndim != 1:
-        raise ValueError('only 1-dimensional arrays can be used')
-
-    if n == 1:
-        if axis == 0:
-            return np.atleast_2d(x)
-        else:
-            return np.atleast_2d(x).T
-    if n < 1:
-        raise ValueError('n cannot be less than 1')
-
-    # np.lib.stride_tricks.as_strided easily leads to memory corruption for
-    # non integer shape and strides, i.e. n. See #3845.
-    n = int(n)
-
-    if axis == 0:
-        shape = (n, x.size)
-        strides = (0, x.strides[0])
-    else:
-        shape = (x.size, n)
-        strides = (x.strides[0], 0)
-
-    return np.lib.stride_tricks.as_strided(x, shape=shape, strides=strides)
-
-
 def _spectral_helper(x, y=None, NFFT=None, Fs=None, detrend_func=None,
                      window=None, noverlap=None, pad_to=None,
                      sides=None, scale_by_freq=None, mode=None):
diff --git a/lib/matplotlib/tests/test_mlab.py b/lib/matplotlib/tests/test_mlab.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``matplotlib.mlab``
	`2`	`+~~~~~~~~~~~~~~~~~~~`
	`3`	+``mlab.apply_window`` and ``mlab.stride_repeat`` have been removed.