nums.numpy.nanmean

nums.numpy.nanmean(a, axis=None, dtype=None, out=None, keepdims=False)[source]

Compute the arithmetic mean along the specified axis, ignoring NaNs.

This docstring was copied from numpy.nanmean.

Some inconsistencies with the NumS version may exist.

Returns the average of the array elements. The average is taken over the flattened array by default, otherwise over the specified axis. float intermediate and return values are used for integer inputs.

For all-NaN slices, NaN is returned and a RuntimeWarning is raised.

Parameters

  • a (BlockArray) – Array containing numbers whose mean is desired. If a is not an array, a conversion is attempted.

  • axis ({int, tuple of int, None}, 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 inexact inputs, it is the same as the input dtype.

  • out (BlockArray, optional) – Alternate output array in which to place the result. The default is None; if provided, it must have the same shape as the expected output, but the type will be cast if necessary.

  • keepdims (bool, optional) – If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original a. If the value is anything but the default, then keepdims will be passed through to the mean or sum methods of sub-classes of BlockArray. If the sub-classes methods does not implement keepdims any exceptions will be raised.

Returns

m – If out=None, returns a new array containing the mean values, otherwise a reference to the output array is returned. Nan is returned for slices that contain only NaNs.

Return type

BlockArray, see dtype parameter above

See also

average

Weighted average

mean

Arithmetic mean taken while not ignoring NaNs

var, nanvar

Notes

The arithmetic mean is the sum of the non-NaN elements along the axis divided by the number of non-NaN elements.

Note that for floating-point input, the mean is computed using the same precision the input has. Depending on the input data, this can cause the results to be inaccurate, especially for float32. Specifying a higher-precision accumulator using the dtype keyword can alleviate this issue.

‘out’ is currently not supported.

Examples

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

>>> a = nps.array([[1, nps.nan], [3, 4]])  
>>> nps.nanmean(a).get()  
array(2.66666667)
>>> nps.nanmean(a, axis=0).get()  
array([2.,  4.])
>>> nps.nanmean(a, axis=1).get()  
array([1.,  3.5]) # may vary