Clarified correct return tuple for kFRSearch()
authorDmitriy Morozov <dmitriy@mrzv.org>
Thu, 03 Sep 2009 18:36:00 -0700
changeset 9 0c2b965c8824
parent 8 ef31983c4dd2
child 10 f702cd835ca4
Clarified correct return tuple for kFRSearch()
README
--- a/README	Tue Sep 01 11:11:18 2009 -0700
+++ b/README	Thu Sep 03 18:36:00 2009 -0700
@@ -101,7 +101,9 @@
 
     `kFRSearch(q, sqRad, k, eps)`
         Fixed radius search. Find at most `k` nearest neighbors of the query point
-        `q` within radius `sqRad`, with an allowed error of `eps`.
+        `q` within radius `sqRad`, with an allowed error of `eps`. Returns
+        `(idx,dists,k)`; the first two are the same as above, and the last is
+        the number of neighbors found.
 
     `__len__()`
         Returns number of points in the `KDTree`.