iarray.IArray.max#

IArray.max(axis: Optional[Union[int, tuple]] = None, cfg: Optional[Config] = None, **kwargs)#

Return the maximum of an array or maximum along an axis.

Parameters
  • a(self) (IArray container) – Input data.

  • 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.

  • 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

max – Maximum of a. If axis is None, the result is a value. If axis is given, the result is an array of dimension a.ndim - len(axis). The dtype is always the dtype of a.

Return type

IArray container or float