better name for interior_extrema and docs

brunobeltran · brunobeltran · commit 692c20cf3467 · 2020-03-20T16:44:50.000-07:00
diff --git a/lib/matplotlib/bezier.py b/lib/matplotlib/bezier.py
@@ -271,8 +271,10 @@ def polynomial_coefficients(self):
         Returns
         -------
         coefs : float, (n+1, d) array_like
-            coefficients after expanding in polynomial basis, where n is the
-            degree of the bezier curve
+            Coefficients after expanding in polynomial basis, where `n` is the
+            degree of the bezier curve and `d` its dimension.
+            These are the numbers (:math:`C_j`) such that the curve can be
+            written :math:`\sum_{j=0}^n C_j t^j`.
 
         Notes
         -----
@@ -282,6 +284,7 @@ def polynomial_coefficients(self):
 
             {n \choose j} \sum_{i=0}^j (-1)^{i+j} {j \choose i} P_i
 
+        where :math:`P_i` are the control points of the curve.
         """
         n = self.degree
         # matplotlib uses n <= 4. overflow plausible starting around n = 15.
@@ -299,18 +302,19 @@ def polynomial_coefficients(self):
         return coefs
 
     @property
-    def interior_extrema(self):
+    def axis_aligned_extrema(self):
         """
         Return the location along the curve's interior where its partial
         derivative is zero, along with the dimension along which it is zero for
-        each instance.
+        each such instance.
 
         Returns
         -------
         dims : int, array_like
-            dimension $i$ along which the corresponding zero occurs
+            dimension :math:`i` along which the corresponding zero occurs
         dzeros : float, array_like
-            of same size as dims. the $t$ such that $d/dx_i B(t) = 0$
+            of same size as dims. the :math:`t` such that :math:`d/dx_i B(t) =
+            0`
         """
         n = self.degree
         Cj = self.polynomial_coefficients
@@ -325,7 +329,7 @@ def interior_extrema(self):
             dims.append(i*np.ones_like(r))
         roots = np.concatenate(roots)
         dims = np.concatenate(dims)
-        in_range = np.isreal(roots) & (roots > 0) & (roots < 1)
+        in_range = np.isreal(roots) & (roots >= 0) & (roots <= 1)
         return dims[in_range], np.real(roots)[in_range]
 
 
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -627,7 +627,7 @@ def get_exact_extents(self, **kwargs):
             _update_extents(extents, curve(0))  # start point
             _update_extents(extents, curve(1))  # end point
             # interior extrema where d/ds B(s) == 0
-            _, dzeros = curve.interior_extrema
+            _, dzeros = curve.axis_aligned_extrema
             if len(dzeros) == 0:
                 continue
             for zero in dzeros:
