Merge pull request matplotlib#12165 from dstansby/mlab-remove

Remove deprecated mlab code

Author: jklymak

doc/api/next_api_changes/2018-09-18-DS-mlab.rst

@@ -0,0 +1,75 @@
+Removal of deprecated :mod:`matplotlib.mlab` code
+-------------------------------------------------
+
+Lots of code inside the :mod:`matplotlib.mlab` module which was deprecated
+in Matplotlib 2.2 has been removed. See below for a list:
+
+- ``mlab.exp_safe`` (use `numpy.exp` instead)
+- ``mlab.amap``
+- ``mlab.logspace`` (use `numpy.logspace` instead)
+- ``mlab.rms_flat``
+- ``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.identity`` (use `numpy.identity` instead)
+- ``mlab.base_repr``
+- ``mlab.binary_repr``
+- ``mlab.ispower2``
+- ``mlab.log2`` (use `numpy.log2` instead)
+- ``mlab.isvector``
+- ``mlab.movavg``
+- ``mlab.safe_isinf`` (use `numpy.isinf` instead)
+- ``mlab.safe_isnan`` (use `numpy.isnan` instead)
+- ``mlab.cohere_pairs`` (use `scipy.signal.coherence` instead)
+- ``mlab.entropy`` (use `scipy.stats.entropy` instead)
+- ``mlab.normpdf`` (use `scipy.stats.norm.pdf` instead)
+- ``mlab.find`` (use ``np.nonzero(np.ravel(condition))`` instead)
+- ``mlab.longest_contiguous_ones``
+- ``mlab.longest_ones``
+- ``mlab.PCA``
+- ``mlab.prctile`` (use `numpy.percentile` instead)
+- ``mlab.prctile_rank``
+- ``mlab.center_matrix``
+- ``mlab.rk4`` (use `scipy.integrate.ode` instead)
+- ``mlab.bivariate_normal``
+- ``mlab.get_xyz_where``
+- ``mlab.get_sparse_matrix``
+- ``mlab.dist`` (use `numpy.hypot` instead)
+- ``mlab.dist_point_to_segment``
+- ``mlab.griddata`` (use `scipy.interpolate.griddata`)
+- ``mlab.less_simple_linear_interpolation`` (use `numpy.interp`)
+- ``mlab.slopes``
+- ``mlab.stineman_interp``
+- ``mlab.segments_intersect``
+- ``mlab.fftsurr``
+- ``mlab.offset_line``
+- ``mlab.quad2cubic``
+- ``mlab.vector_lengths``
+- ``mlab.distances_along_curve``
+- ``mlab.path_length``
+- ``mlab.cross_from_above``
+- ``mlab.cross_from_below``
+- ``mlab.contiguous_regions`` (use `.cbook.contiguous_regions` instead)
+- ``mlab.is_closed_polygon``
+- ``mlab.poly_between``
+- ``mlab.poly_below``
+- ``mlab.inside_poly``
+- ``mlab.csv2rec``
+- ``mlab.rec2csv`` (use `numpy.recarray.tofile` instead)
+- ``mlab.rec2text`` (use `numpy.recarray.tofile` instead)
+- ``mlab.rec_summarize``
+- ``mlab.rec_join``
+- ``mlab.recs_join``
+- ``mlab.rec_groupby``
+- ``mlab.rec_keep_fields``
+- ``mlab.rec_drop_fields``
+- ``mlab.rec_append_fields``
+- ``mlab.csvformat_factory``
+- ``mlab.get_formatd``
+- ``mlab.FormatDatetime`` (use `datetime.datetime.strftime` instead)
+- ``mlab.FormatDate`` (use `datetime.date.strftime` instead)
+- ``mlab.FormatMillions``, ``mlab.FormatThousands``, ``mlab.FormatPercent``,
+  ``mlab.FormatBool``, ``mlab.FormatInt``, ``mlab.FormatFloat``,
+  ``mlab.FormatFormatStr``, ``mlab.FormatString``, ``mlab.FormatObj``
+- ``mlab.donothing_callback``

doc/api/next_api_changes/2018-09-18-DS-pylab.rst

@@ -0,0 +1,52 @@
+Removal of deprecated :mod:`matplotlib.pylab` code
+--------------------------------------------------
+
+Lots of code inside the :mod:`matplotlib.mlab` module which was deprecated
+in Matplotlib 2.2 has been removed. This means the following functions are
+no longer available in the `matplotlib.pylab` module:
+
+  - ``amap``
+  - ``base_repr``
+  - ``binary_repr``
+  - ``bivariate_normal``
+  - ``center_matrix``
+  - ``csv2rec`` (use `numpy.recarray.tofile` instead)
+  - ``dist`` (use `numpy.hypot` instead)
+  - ``dist_point_to_segment``
+  - ``distances_along_curve``
+  - ``entropy`` (use `scipy.stats.entropy` instead)
+  - ``exp_safe`` (use `numpy.exp` instead)
+  - ``fftsurr``
+  - ``find`` (use ``np.nonzero(np.ravel(condition))`` instead)
+  - ``frange`` (use `numpy.arange` instead)
+  - ``get_sparse_matrix``
+  - ``get_xyz_where``
+  - ``griddata`` (use `scipy.interpolate.griddata` instead)
+  - ``identity`` (use `numpy.identity` instead)
+  - ``inside_poly``
+  - ``is_closed_polygon``
+  - ``ispower2``
+  - ``isvector``
+  - ``l1norm`` (use ``numpy.linalg.norm(a, ord=1)`` instead)
+  - ``l2norm`` (use ``numpy.linalg.norm(a, ord=2)`` instead)
+  - ``log2`` (use `numpy.log2` instead)
+  - ``longest_contiguous_ones``
+  - ``longest_ones``
+  - ``movavg``
+  - ``norm_flat`` (use ``numpy.linalg.norm(a.flat, ord=2)`` instead)
+  - ``normpdf`` (use `scipy.stats.norm.pdf` instead)
+  - ``path_length``
+  - ``poly_below``
+  - ``poly_between``
+  - ``prctile`` (use `numpy.percentile` instead)
+  - ``prctile_rank``
+  - ``rec2csv`` (use `numpy.recarray.tofile` instead)
+  - ``rec_append_fields``
+  - ``rec_drop_fields``
+  - ``rec_join``
+  - ``rk4`` (use `scipy.integrate.ode` instead)
+  - ``rms_flat``
+  - ``segments_intersect``
+  - ``slopes``
+  - ``stineman_interp``
+  - ``vector_lengths``

examples/event_handling/poly_editor.py

@@ -9,7 +9,34 @@
 import numpy as np
 from matplotlib.lines import Line2D
 from matplotlib.artist import Artist
-from matplotlib.mlab import dist_point_to_segment
+
+
+def dist(x, y):
+    """
+    Return the distance between two points.
+    """
+    d = x - y
+    return np.sqrt(np.dot(d, d))
+
+
+def dist_point_to_segment(p, s0, s1):
+    """
+    Get the distance of a point to a segment.
+      *p*, *s0*, *s1* are *xy* sequences
+    This algorithm from
+    http://geomalgorithms.com/a02-_lines.html
+    """
+    v = s1 - s0
+    w = p - s0
+    c1 = np.dot(w, v)
+    if c1 <= 0:
+        return dist(p, s0)
+    c2 = np.dot(v, v)
+    if c2 <= c1:
+        return dist(p, s1)
+    b = c1 / c2
+    pb = s0 + b * v
+    return dist(p, pb)
 
 
 class PolygonInteractor(object):