diff options
author | Pauli Virtanen <pav@iki.fi> | 2009-10-02 19:27:46 +0000 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2009-10-02 19:27:46 +0000 |
commit | 1521f6689a3cc48d60a75097a7ffcf4d51f9dc47 (patch) | |
tree | a0f048838717b7ee43177007ec42c3102ea7be25 /numpy/core/fromnumeric.py | |
parent | 8c7d1bc554e6b5bbb7900a2f6d976d72795bb454 (diff) | |
download | numpy-1521f6689a3cc48d60a75097a7ffcf4d51f9dc47.tar.gz |
Docstring updates, part 1
Diffstat (limited to 'numpy/core/fromnumeric.py')
-rw-r--r-- | numpy/core/fromnumeric.py | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index f7f584d3d..de8a27d08 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -1351,14 +1351,15 @@ def any(a,axis=None, out=None): a : array_like Input array or object that can be converted to an array. axis : int, optional - Axis along which an logical OR is performed. + Axis along which a logical OR is performed. The default (`axis` = `None`) is to perform a logical OR over a flattened input array. `axis` may be negative, in which case it counts from the last to the first axis. out : ndarray, optional Alternative output array in which to place the result. It must have the same shape as the expected output and - the type is preserved. + the type is preserved. See `doc.ufuncs` (Section + "Output arguments") for details. Returns ------- @@ -1370,6 +1371,9 @@ def any(a,axis=None, out=None): -------- ndarray.any : equivalent method + all : Test whether all array elements along a given axis evaluate + to True. + Notes ----- Not a Number (NaN), positive infinity and negative infinity @@ -1391,8 +1395,13 @@ def any(a,axis=None, out=None): >>> o=np.array([False]) >>> z=np.any([-1, 4, 5], out=o) - >>> id(z), id(o), z - (28224368, 28224368, array([ True], dtype=bool)) + >>> z, o + (array([ True], dtype=bool), array([ True], dtype=bool)) + >>> # Check now that z is a reference to o + >>> z is o + True + >>> id(z), id(o) # identity of z and o + (191614240, 191614240) """ try: @@ -1693,12 +1702,12 @@ def alen(a): Returns ------- - alen : int + l : int Length of the first dimension of `a`. See Also -------- - shape + shape, size Examples -------- |