summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorSkipper Seabold <jsseabold@gmail.com>2012-04-03 20:00:58 -0400
committerSkipper Seabold <jsseabold@gmail.com>2012-04-03 20:23:04 -0400
commit0488f85de8a9ec3755198f57d40e9b091ca2aaee (patch)
treef2239eb20dbf9c3dbaecbed73a6bdd28de1a61b6 /numpy/add_newdocs.py
parent0d1b60136862dd831ca586516d47561181e321ec (diff)
downloadnumpy-0488f85de8a9ec3755198f57d40e9b091ca2aaee.tar.gz
ENH: Give digitize left or right open interval option
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py13
1 files changed, 11 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 6b7d98c4d..185fb7425 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -4865,14 +4865,17 @@ add_newdoc('numpy.core.umath', 'seterrobj',
add_newdoc('numpy.lib._compiled_base', 'digitize',
"""
- digitize(x, bins)
+ digitize(x, bins, right=False)
Return the indices of the bins to which each value in input array belongs.
Each index ``i`` returned is such that ``bins[i-1] <= x < bins[i]`` if
`bins` is monotonically increasing, or ``bins[i-1] > x >= bins[i]`` if
`bins` is monotonically decreasing. If values in `x` are beyond the
- bounds of `bins`, 0 or ``len(bins)`` is returned as appropriate.
+ bounds of `bins`, 0 or ``len(bins)`` is returned as appropriate. If right
+ is True, then the right bin is closed so that the index ``i`` is such
+ that ``bins[i-1] < x <= bins[i]`` or bins[i-1] >= x > bins[i]`` if `bins`
+ is monotonically increasing or decreasing, respectively.
Parameters
----------
@@ -4880,6 +4883,12 @@ add_newdoc('numpy.lib._compiled_base', 'digitize',
Input array to be binned. It has to be 1-dimensional.
bins : array_like
Array of bins. It has to be 1-dimensional and monotonic.
+ right : bool, optional
+ Indicating whether the intervals include the right or the left bin.
+ Default behavior is (right==False) indicating that the interval
+ includes the left bin and is open on the right. Ie.,
+ bins[i-1] <= x < bins[i] is the default behavior for monotonically
+ increasing bins.
Returns
-------