summaryrefslogtreecommitdiff
path: root/numpy/core/fromnumeric.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2006-09-03 02:26:26 +0000
committerCharles Harris <charlesr.harris@gmail.com>2006-09-03 02:26:26 +0000
commit6f31fbc4da05ddaec34fde5cd455b5028e60b355 (patch)
tree289e82844feee7388ef07f2e4b7de79fb1a7f13f /numpy/core/fromnumeric.py
parent92abb2700078ae4a4e1da4df8a075e3134a86216 (diff)
downloadnumpy-6f31fbc4da05ddaec34fde5cd455b5028e60b355.tar.gz
Add new keyword <side> to the searchsorted method and function.
Add documentation thereto. Cleanup whitespace.
Diffstat (limited to 'numpy/core/fromnumeric.py')
-rw-r--r--numpy/core/fromnumeric.py43
1 files changed, 39 insertions, 4 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py
index 1942bda45..1ec9af08e 100644
--- a/numpy/core/fromnumeric.py
+++ b/numpy/core/fromnumeric.py
@@ -220,14 +220,49 @@ def argmin(a, axis=None):
return _wrapit(a, 'argmin', axis)
return argmin(axis)
-def searchsorted(a, v):
- """searchsorted(a, v)
+def searchsorted(a, v, side ='left'):
+ """-> array ind. Inserting v[i] before a[ind[i]] will leave a in order.
+
+ Required Arguments:
+ a -- sorted 1-D array to be searched.
+ v -- keys to be searched for in a.
+
+ Keyword arguments
+ side -- {'left', 'right'}, default('left').
+
+ If a is a 1-D array in ascending order, then
+
+ searchsorted(a, v, side='left')
+
+ returns an array of indices i such that for each element of values the
+ following holds:
+
+ a[j] < key <= a[i] for all j < i,
+
+ If such an index does not exist, a.size() is used. The result is such that
+ if the key were to be inserted in the slot before the index i, then the
+ order of a would be preserved and i would be the smallest index with that
+ property.
+
+ If a is a 1-D array in ascending order, then
+
+ searchsorted(a, v, side='right')
+
+ returns an array of indices i such that for each element of values the
+ following holds:
+
+ a[j] <= key < a[i] for all j < i,
+
+ If such an index does not exist, a.size() is used. The result is that if the
+ key were to be inserted in the slot before the index i, then the order of a
+ would be preserved and i would be the largest index with that property.
+
"""
try:
searchsorted = a.searchsorted
except AttributeError:
- return _wrapit(a, 'searchsorted', v)
- return searchsorted(v)
+ return _wrapit(a, 'searchsorted', v, side)
+ return searchsorted(v, side)
def resize(a, new_shape):
"""resize(a,new_shape) returns a new array with the specified shape.