diff options
| author | Cimarron Mittelsteadt <cimarronm@gmail.com> | 2014-10-02 17:24:24 -0700 |
|---|---|---|
| committer | Cimarron Mittelsteadt <cimarronm@gmail.com> | 2014-10-02 17:24:24 -0700 |
| commit | aaa8940913902001a4961d793e7238eafc193861 (patch) | |
| tree | 9b64fca25ac9cbc3ff4c394c9fe8fa0fae33bfb1 | |
| parent | 58350f4608a22f4b4b66795f51eaefc206bd02b8 (diff) | |
| download | numpy-aaa8940913902001a4961d793e7238eafc193861.tar.gz | |
DOC: Updated from numeric doc to indicate where axis can also be a tuple of ints, i.e. axes, over which to perform the given operation
| -rw-r--r-- | numpy/core/fromnumeric.py | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 1cb1ed8bc..01325728c 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -2095,8 +2095,9 @@ def amax(a, axis=None, out=None, keepdims=False): ---------- a : array_like Input data. - axis : int, optional - Axis along which to operate. By default, flattened input is used. + axis : int or tuple of ints, optional + Axis or axes along which to operate. By default, flattened input is + used. out : ndarray, optional Alternative output array in which to place the result. Must be of the same shape and buffer length as the expected output. @@ -2179,8 +2180,9 @@ def amin(a, axis=None, out=None, keepdims=False): ---------- a : array_like Input data. - axis : int, optional - Axis along which to operate. By default, flattened input is used. + axis : int or tuple of ints, optional + Axis or axes along which to operate. By default, flattened input is + used. out : ndarray, optional Alternative output array in which to place the result. Must be of the same shape and buffer length as the expected output. @@ -2693,9 +2695,9 @@ def mean(a, axis=None, dtype=None, out=None, keepdims=False): a : array_like Array containing numbers whose mean is desired. If `a` is not an array, a conversion is attempted. - axis : int, optional - Axis along which the means are computed. The default is to compute - the mean of the flattened array. + axis : int or tuple of ints, optional + Axis or axes along which the means are computed. The default is to + compute the mean of the flattened array. dtype : data-type, optional Type to use in computing the mean. For integer inputs, the default is `float64`; for floating point inputs, it is the same as the @@ -2778,9 +2780,9 @@ def std(a, axis=None, dtype=None, out=None, ddof=0, keepdims=False): ---------- a : array_like Calculate the standard deviation of these values. - axis : int, optional - Axis along which the standard deviation is computed. The default is - to compute the standard deviation of the flattened array. + axis : int or tuple of ints, optional + Axis or axes along which the standard deviation is computed. The + default is to compute the standard deviation of the flattened array. dtype : dtype, optional Type to use in computing the standard deviation. For arrays of integer type the default is float64, for arrays of float types it is @@ -2881,9 +2883,9 @@ def var(a, axis=None, dtype=None, out=None, ddof=0, a : array_like Array containing numbers whose variance is desired. If `a` is not an array, a conversion is attempted. - axis : int, optional - Axis along which the variance is computed. The default is to compute - the variance of the flattened array. + axis : int or tuple of ints, optional + Axis or axes along which the variance is computed. The default is to + compute the variance of the flattened array. dtype : data-type, optional Type to use in computing the variance. For arrays of integer type the default is `float32`; for arrays of float types it is the same as |