iarray.mean#

iarray.mean(a: IArray, /, *, axis: Optional[Union[int, tuple]] = None, keepdims: bool = False, oneshot: bool = False, cfg: Optional[Config] = None, **kwargs)#

Compute the arithmetic mean along the specified axis. Returns the average of the array elements.

Parameters
  • a (IArray container) – Input data. Should have a floating-point data type.

  • axis (None, int, tuple of ints, optional) – Axis or axes along which the reduction is performed. The default (axis = None) is perform the reduction over all dimensions of the input array. If this is a tuple of ints, a reduction is performed on multiple axes, instead of a single axis or all the axes as default.

  • oneshot (bool) – Enforce the use of the oneshot algorithm. Oneshot normally uses less memory, albeit is slower in general. Default is False.

  • keepdims (bool) – Whether to keep the reduced axes in the result or not. The only supported value for this param is False (the default).

  • cfg (Config or None) – The configuration for this operation. If None (default), the current configuration will be used.

  • kwargs (dict) – A dictionary for setting some or all of the fields in the Config dataclass that should override the current configuration.

Returns

mean – Mean of a. The result is an array of dimension a.ndim - len(axis). Its dtype is np.float32 when the dtype of a is np.float32 and np.float64 otherwise.

Return type

IArray container