Compute the arithmetic mean along the specified axis, ignoring NaNs. Returns the average of the array elements. The average is taken over the flattened array by default, otherwise over the specified axis. `float64` intermediate and return values are used for integer inputs. F
(a, axis=None, dtype=None, out=None, keepdims=np._NoValue,
*, where=np._NoValue)
| 951 | |
| 952 | @array_function_dispatch(_nanmean_dispatcher) |
| 953 | def nanmean(a, axis=None, dtype=None, out=None, keepdims=np._NoValue, |
| 954 | *, where=np._NoValue): |
| 955 | """ |
| 956 | Compute the arithmetic mean along the specified axis, ignoring NaNs. |
| 957 | |
| 958 | Returns the average of the array elements. The average is taken over |
| 959 | the flattened array by default, otherwise over the specified axis. |
| 960 | `float64` intermediate and return values are used for integer inputs. |
| 961 | |
| 962 | For all-NaN slices, NaN is returned and a `RuntimeWarning` is raised. |
| 963 | |
| 964 | .. versionadded:: 1.8.0 |
| 965 | |
| 966 | Parameters |
| 967 | ---------- |
| 968 | a : array_like |
| 969 | Array containing numbers whose mean is desired. If `a` is not an |
| 970 | array, a conversion is attempted. |
| 971 | axis : {int, tuple of int, None}, optional |
| 972 | Axis or axes along which the means are computed. The default is to compute |
| 973 | the mean of the flattened array. |
| 974 | dtype : data-type, optional |
| 975 | Type to use in computing the mean. For integer inputs, the default |
| 976 | is `float64`; for inexact inputs, it is the same as the input |
| 977 | dtype. |
| 978 | out : ndarray, optional |
| 979 | Alternate output array in which to place the result. The default |
| 980 | is ``None``; if provided, it must have the same shape as the |
| 981 | expected output, but the type will be cast if necessary. See |
| 982 | :ref:`ufuncs-output-type` for more details. |
| 983 | keepdims : bool, optional |
| 984 | If this is set to True, the axes which are reduced are left |
| 985 | in the result as dimensions with size one. With this option, |
| 986 | the result will broadcast correctly against the original `a`. |
| 987 | |
| 988 | If the value is anything but the default, then |
| 989 | `keepdims` will be passed through to the `mean` or `sum` methods |
| 990 | of sub-classes of `ndarray`. If the sub-classes methods |
| 991 | does not implement `keepdims` any exceptions will be raised. |
| 992 | where : array_like of bool, optional |
| 993 | Elements to include in the mean. See `~numpy.ufunc.reduce` for details. |
| 994 | |
| 995 | .. versionadded:: 1.22.0 |
| 996 | |
| 997 | Returns |
| 998 | ------- |
| 999 | m : ndarray, see dtype parameter above |
| 1000 | If `out=None`, returns a new array containing the mean values, |
| 1001 | otherwise a reference to the output array is returned. Nan is |
| 1002 | returned for slices that contain only NaNs. |
| 1003 | |
| 1004 | See Also |
| 1005 | -------- |
| 1006 | average : Weighted average |
| 1007 | mean : Arithmetic mean taken while not ignoring NaNs |
| 1008 | var, nanvar |
| 1009 | |
| 1010 | Notes |
nothing calls this directly
no test coverage detected