diff options
| author | Jarrod Millman <millman@berkeley.edu> | 2010-02-17 23:53:04 +0000 |
|---|---|---|
| committer | Jarrod Millman <millman@berkeley.edu> | 2010-02-17 23:53:04 +0000 |
| commit | e2bb09430d90c73a7be6e47ea8c4528f094f693f (patch) | |
| tree | 3ded297a6cbe634446d6a54afc4e95c8c71553e6 /numpy/lib/function_base.py | |
| parent | dcc721a5bddde3afd4ce47d7a7b76ec6c7102b92 (diff) | |
| download | numpy-e2bb09430d90c73a7be6e47ea8c4528f094f693f.tar.gz | |
more docstring updates from pydoc website (thanks to everyone who contributed!)
Diffstat (limited to 'numpy/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 92fcf5378..a1f7102df 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -1366,24 +1366,20 @@ def nansum(a, axis=None): def nanmin(a, axis=None): """ - Return the minimum of array elements over the given axis ignoring any NaNs. + Return the minimum of an array or minimum along an axis ignoring any NaNs. Parameters ---------- a : array_like - Array containing numbers whose sum is desired. If `a` is not - an array, a conversion is attempted. + Array containing numbers whose minimum is desired. axis : int, optional Axis along which the minimum is computed.The default is to compute the minimum of the flattened array. Returns ------- - y : {ndarray, scalar} - An array with the same shape as `a`, with the specified axis removed. - If `a` is a 0-d array, or if axis is None, a scalar is returned. The - the same dtype as `a` is returned. - + nanmin : ndarray + A new array or a scalar array with the result. See Also -------- @@ -1461,7 +1457,7 @@ def nanargmin(a, axis=None): def nanmax(a, axis=None): """ - Return the maximum of array elements over the given axis ignoring any NaNs. + Return the maximum of an array or maximum along an axis ignoring any NaNs. Parameters ---------- @@ -1469,15 +1465,15 @@ def nanmax(a, axis=None): Array containing numbers whose maximum is desired. If `a` is not an array, a conversion is attempted. axis : int, optional - Axis along which the maximum is computed.The default is to compute + Axis along which the maximum is computed. The default is to compute the maximum of the flattened array. Returns ------- - y : ndarray + nanmax : ndarray An array with the same shape as `a`, with the specified axis removed. - If `a` is a 0-d array, or if axis is None, a scalar is returned. The - the same dtype as `a` is returned. + If `a` is a 0-d array, or if axis is None, a ndarray scalar is + returned. The the same dtype as `a` is returned. See Also -------- |