summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2006-09-07 17:13:42 +0000
committerCharles Harris <charlesr.harris@gmail.com>2006-09-07 17:13:42 +0000
commit49f41ff05c4ed9442539debe1e612a2ea557e122 (patch)
tree2dd4d241e09e2ff4972fadeefca7bac394bcde3e /numpy/add_newdocs.py
parent8c2697178d1b7332bc300475f4d7e6b86bb6c9e8 (diff)
downloadnumpy-49f41ff05c4ed9442539debe1e612a2ea557e122.tar.gz
Documentation tweaks for searchsorted and round.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py29
1 files changed, 15 insertions, 14 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index bfa5ea45c..07b3a69ff 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -937,17 +937,18 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('round',
Reference to out, where None specifies the original array a.
Round to the specified number of decimals. When 'decimals' is negative it
- specifies the number of positions to the left of the decimal point. The real
- and imaginary parts of complex numbers are rounded separately. Nothing is
- done if the array is not of float type and 'decimals' is >= 0.
+ specifies the number of positions to the left of the decimal point. The
+ real and imaginary parts of complex numbers are rounded separately. Nothing
+ is done if the array is not of float type and 'decimals' is >= 0.
The keyword 'out' may be used to specify a different array to hold the
result rather than the default 'a'. If the type of the array specified by
- 'out' differs from that of 'a', the result is cast to the new type.
+ 'out' differs from that of 'a', the result is cast to the new type,
+ otherwise the original type is kept. Floats round to floats by default.
- Numpy rounds to even. Thus 1.5 and 2.5 round to 2, -0.5 and 0.5 round to 0,
- etc. Results may also be surprising due to the inexact representation of
- decimal fractions in IEEE floating point and the errors introduced in
+ Numpy rounds to even. Thus 1.5 and 2.5 round to 2.0, -0.5 and 0.5 round to
+ 0.0, etc. Results may also be surprising due to the inexact representation
+ of decimal fractions in IEEE floating point and the errors introduced in
scaling the numbers when 'decimals' is something other than 0.
"""))
@@ -960,7 +961,7 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('searchsorted',
v -- array of keys to be searched for in a.
Keyword arguments:
- side -- {'left', 'right'}, default('left').
+ side -- {'left', 'right'}, (default 'left').
Returns:
index array with the same shape as keys.
@@ -978,9 +979,9 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('searchsorted',
a[j] < key <= a[i] for all j < i,
If such an index does not exist, a.size() is used. Consequently, i is the
- index of the first item in a that is >= key. If the key were to be inserted
- into a 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.
+ index of the first item in 'a' that is >= key. If the key were to be
+ inserted into a 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.
The method call
@@ -992,9 +993,9 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('searchsorted',
a[j] <= key < a[i] for all j < i,
If such an index does not exist, a.size() is used. Consequently, i is the
- index of the first item in a that is > key. If the key were to be inserted
- into a 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.
+ index of the first item in 'a' that is > key. If the key were to be
+ inserted into a 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.
"""))