numpy.amax

numpy.amax(a, axis=None, out=None)

Return the maximum along an axis.

Parameters:

a : array_like

Input data.

axis : int, optional

Axis along which to operate. By default flattened input is used.

out : ndarray, optional

Alternative output array in which to place the result. Must be of the same shape and buffer length as the expected output.

Returns:

amax : ndarray

A new array or a scalar with the result, or a reference to out if it was specified.

See also

nanmax
nan values are ignored instead of being propagated
fmax
same behavior as the C99 fmax function

Notes

NaN values are propagated, that is if at least one item is nan, the corresponding max value will be nan as well. To ignore NaN values (matlab behavior), please use nanmax.

Examples

>>> a = np.arange(4).reshape((2,2))
>>> a
array([[0, 1],
       [2, 3]])
>>> np.amax(a, axis=0)
array([2, 3])
>>> np.amax(a, axis=1)
array([1, 3])

Previous topic

numpy.amin

Next topic

numpy.nanmax

This Page

Quick search