numpy.fmax(x1, x2[, out]) = <ufunc 'fmax'>

Element-wise maximum of array elements.

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 :

x1, x2 : array_like

The arrays holding the elements to be compared. They must have the same shape.

Returns :

y : {ndarray, scalar}

The minimum of x1 and x2, element-wise. Returns scalar if both x1 and x2 are scalars.

See also

Element-wise minimum of two arrays, ignoring any NaNs.
Element-wise maximum of two arrays, propagating any NaNs.
The maximum value of an array along a given axis, propagating any NaNs.
The maximum value of an array along a given axis, ignoring any NaNs.

minimum, amin, nanmin


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.


>>> 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])

Previous topic


Next topic