summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2013-06-23 15:47:59 -0600
committerCharles Harris <charlesr.harris@gmail.com>2013-08-12 22:33:56 -0600
commitc7dd1e5295fcc0218bab764185ff047ee7057c77 (patch)
tree20ca31e50249b40a30c65a81e0e3d8333711495a /doc
parent6a02d054d2f74dc675497144a4819ce6be7835cb (diff)
downloadnumpy-c7dd1e5295fcc0218bab764185ff047ee7057c77.tar.gz
MAINT: Refactor nanfunctions.
nanmax, nanmin -------------- Add out and keepdims keywords. nanargmin, nanargmax -------------------- A NanWarning is raised if an all NaN slice detected. For all such slices np.iingo(np.intp).min is returned as the index value. nansum ------ The keywords dtype, out, and keepdims are added. A FutureWarning is raised, as in the future the mean of an empty slice after NaN replacement will be 0 instead of the current NaN. nanmean, nanvar, nanstd ----------------------- For all, if the input array is of inexact type then the dtype and out parameters must be of inexact type if specified. That insures that NaNs can be returned when appropriate. The nanmean function detects empty slices after NaN replacement and raises a NanWarning. NaN is returned as the value for all such slices. The nanmean and nanstd functions detect degrees of freedom <= 0 after NaN replacement and raise a NanWarning. NaN is returned as the value for all such slices.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/reference/routines.statistics.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/source/reference/routines.statistics.rst b/doc/source/reference/routines.statistics.rst
index c420705af..64745ff0c 100644
--- a/doc/source/reference/routines.statistics.rst
+++ b/doc/source/reference/routines.statistics.rst
@@ -23,11 +23,14 @@ Averages and variances
.. autosummary::
:toctree: generated/
+ median
average
mean
- median
std
var
+ nanmean
+ nanstd
+ nanvar
Correlating
-----------