Remove mlab.dist, mlab.dist_point_to_segment

dstansby · dstansby · commit 563bc0de45fa · 2018-09-29T11:05:05.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
@@ -19,4 +19,6 @@ in Matplotlib 2.2 has been removed. See below for a list:
 - `mlab.bivariate_normal`
 - `mlab.get_xyz_where`
 - `mlab.get_sparse_matrix`
+- `mlab.dist` (use numpy.hypot instead)
+- `mlab.dist_point_to_segment`
 - `mlab.donothing_callback`
diff --git a/examples/event_handling/poly_editor.py b/examples/event_handling/poly_editor.py
@@ -9,7 +9,6 @@
 import numpy as np
 from matplotlib.lines import Line2D
 from matplotlib.artist import Artist
-from matplotlib.mlab import dist_point_to_segment
 
 
 class PolygonInteractor(object):
@@ -85,6 +84,32 @@ def get_ind_under_point(self, event):
 
         return ind
 
+    def dist(self, x, y):
+        """
+        Return the distance between two points.
+        """
+        d = x-y
+        return np.sqrt(np.dot(d, d))
+
+    def dist_point_to_segment(self, 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 self.dist(p, s0)
+        c2 = np.dot(v, v)
+        if c2 <= c1:
+            return self.dist(p, s1)
+        b = c1 / c2
+        pb = s0 + b * v
+        return self.dist(p, pb)
+
     def button_press_callback(self, event):
         'whenever a mouse button is pressed'
         if not self.showverts:
@@ -124,7 +149,7 @@ def key_press_callback(self, event):
             for i in range(len(xys) - 1):
                 s0 = xys[i]
                 s1 = xys[i + 1]
-                d = dist_point_to_segment(p, s0, s1)
+                d = self.dist_point_to_segment(p, s0, s1)
                 if d <= self.epsilon:
                     self.poly.xy = np.insert(
                         self.poly.xy, i+1,
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -1194,44 +1194,6 @@ def cohere(x, y, NFFT=256, Fs=2, detrend=detrend_none, window=window_hanning,
     return Cxy, f
 
 
-@cbook.deprecated('2.2', 'numpy.hypot')
-def dist(x, y):
-    """
-    Return the distance between two points.
-    """
-    d = x-y
-    return np.sqrt(np.dot(d, d))
-
-
-@cbook.deprecated('2.2')
-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
-    """
-    p = np.asarray(p, float)
-    s0 = np.asarray(s0, float)
-    s1 = np.asarray(s1, float)
-    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)
-
-
 @cbook.deprecated('2.2')
 def segments_intersect(s1, s2):
     """
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -231,8 +231,8 @@
 
 from matplotlib.mlab import (
     amap, base_repr, binary_repr, csv2rec,
-    demean, detrend, detrend_linear, detrend_mean, detrend_none, dist,
-    dist_point_to_segment, distances_along_curve, exp_safe,
+    demean, detrend, detrend_linear, detrend_mean, detrend_none,
+    distances_along_curve, exp_safe,
     fftsurr, frange, griddata,
     identity, inside_poly, is_closed_polygon, ispower2, isvector, l1norm,
     l2norm, log2, movavg, norm_flat,
