jax.numpy.fmax

jax.numpy.fmax(x1, x2)[source]

Element-wise maximum of array elements.

LAX-backend implementation of fmax(). Original docstring below.

fmax(x1, x2, /, out=None, *, where=True, casting=’same_kind’, order=’K’, dtype=None, subok=True[, signature, extobj])

Compare two arrays and returns a new array containing the element-wise maxima. If one of the elements being compared is a NaN, then the non-nan element is returned. If both elements are NaNs then the first is returned. The latter distinction is important for complex NaNs, which are defined as at least one of the real or imaginary parts being a NaN. The net effect is that NaNs are ignored when possible.

Parameters

x2 (x1,) – The arrays holding the elements to be compared. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

Returns

y – The maximum of x1 and x2, element-wise. This is a scalar if both x1 and x2 are scalars.

Return type

ndarray or scalar

See also

fmin()

Element-wise minimum of two arrays, ignores NaNs.

maximum()

Element-wise maximum of two arrays, propagates NaNs.

amax()

The maximum value of an array along a given axis, propagates NaNs.

nanmax()

The maximum value of an array along a given axis, ignores NaNs.

minimum(), amin(), nanmin()

Notes

New in version 1.3.0.

The fmax is equivalent to np.where(x1 >= x2, x1, x2) when neither x1 nor x2 are NaNs, but it is faster and does proper broadcasting.

Examples

>>> np.fmax([2, 3, 4], [1, 5, 2])
array([ 2.,  5.,  4.])
>>> np.fmax(np.eye(2), [0.5, 2])
array([[ 1. ,  2. ],
       [ 0.5,  2. ]])
>>> np.fmax([np.nan, 0, np.nan],[0, np.nan, np.nan])
array([ 0.,  0., nan])