Rename valid_index to within_grid.

tonysyu · tonysyu · commit 398e8ecc955e · 2012-02-07T23:14:42.000-05:00
`valid_index` suggests that inputs are integer, which is not true.
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -200,7 +200,7 @@ def reset_start_point(self, xg, yg):
         self.mask._current_xy = (xm, ym)
 
     def update_trajectory(self, xg, yg):
-        if not self.grid.valid_index(xg, yg):
+        if not self.grid.within_grid(xg, yg):
             raise InvalidIndexError
         xm, ym = self.grid2mask(xg, yg)
         self.mask._update_trajectory(xm, ym)
@@ -243,7 +243,7 @@ def __init__(self, x, y):
     def shape(self):
         return self.ny, self.nx
 
-    def valid_index(self, xi, yi):
+    def within_grid(self, xi, yi):
         """Return True if point is a valid index of grid."""
         # Note that xi/yi can be floats; so, for example, we can't simply check
         # `xi < self.nx` since `xi` can be `self.nx - 1 < xi < self.nx`
@@ -402,7 +402,7 @@ def _integrate_rk12(x0, y0, dmap, f):
     xf_traj = []
     yf_traj = []
 
-    while dmap.grid.valid_index(xi, yi):
+    while dmap.grid.within_grid(xi, yi):
         xf_traj.append(xi)
         yf_traj.append(yi)
         try:
