mean¶
- mean(x: array, /, *, axis: int | Tuple[int, ...] | None = None, keepdims: bool = False) array ¶
Calculates the arithmetic mean of the input array
x
.- Parameters:
x (array) – input array. Should have a real-valued floating-point data type.
axis (Optional[Union[int, Tuple[int, ...]]]) – axis or axes along which arithmetic means must be computed. By default, the mean must be computed over the entire array. If a tuple of integers, arithmetic means must be computed over multiple axes. Default:
None
.keepdims (bool) – if
True
, the reduced axes (dimensions) must be included in the result as singleton dimensions, and, accordingly, the result must be compatible with the input array (see Broadcasting). Otherwise, ifFalse
, the reduced axes (dimensions) must not be included in the result. Default:False
.
- Returns:
out (array) – if the arithmetic mean was computed over the entire array, a zero-dimensional array containing the arithmetic mean; otherwise, a non-zero-dimensional array containing the arithmetic means. The returned array must have the same data type as
x
.Note
While this specification recommends that this function only accept input arrays having a real-valued floating-point data type, specification-compliant array libraries may choose to accept input arrays having an integer data type. While mixed data type promotion is implementation-defined, if the input array
x
has an integer data type, the returned array must have the default real-valued floating-point data type.
Notes
Special Cases
Let
N
equal the number of elements over which to compute the arithmetic mean.If
N
is0
, the arithmetic mean isNaN
.If
x_i
isNaN
, the arithmetic mean isNaN
(i.e.,NaN
values propagate).