bundles / numpy 2.4.3 / numpy / nanmin
_ArrayFunctionDispatcher
numpy:nanmin
Signature
def nanmin ( a , axis = None , out = None , keepdims = <no value> , initial = <no value> , where = <no value> ) Summary
Return minimum of an array or minimum along an axis, ignoring any NaNs. When all-NaN slices are encountered a RuntimeWarning is raised and Nan is returned for that slice.
Parameters
a: array_likeArray containing numbers whose minimum is desired. If
ais not an array, a conversion is attempted.axis: {int, tuple of int, None}, optionalAxis or axes along which the minimum is computed. The default is to compute the minimum of the flattened array.
out: ndarray, optionalAlternate output array in which to place the result. The default is
None; if provided, it must have the same shape as the expected output, but the type will be cast if necessary. Seeufuncs-output-typefor more details.keepdims: bool, optionalIf this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original
a.If the value is anything but the default, then
keepdimswill be passed through to the min method of sub-classes ofndarray. If the sub-classes methods does not implementkeepdimsany exceptions will be raised.initial: scalar, optionalThe maximum value of an output element. Must be present to allow computation on empty slice. See
~numpy.ufunc.reducefor details.where: array_like of bool, optionalElements to compare for the minimum. See
~numpy.ufunc.reducefor details.
Returns
nanmin: ndarrayAn array with the same shape as
a, with the specified axis removed. Ifais a 0-d array, or if axis is None, an ndarray scalar is returned. The same dtype asais returned.
Notes
NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic (IEEE 754). This means that Not a Number is not equivalent to infinity. Positive infinity is treated as a very large number and negative infinity is treated as a very small (i.e. negative) number.
If the input has a integer type the function is equivalent to np.min.
Examples
import numpy as np a = np.array([[1, 2], [3, np.nan]])✓
np.nanmin(a) np.nanmin(a, axis=0) np.nanmin(a, axis=1)✗
np.nanmin([1, 2, np.nan, np.inf]) np.nanmin([1, 2, np.nan, -np.inf])✗
See also
- amax
- amin
The minimum value of an array along a given axis, propagating any NaNs.
- fmax
- fmin
Element-wise minimum of two arrays, ignoring any NaNs.
- isfinite
Shows which elements are neither NaN nor infinity.
- isnan
Shows which elements are Not a Number (NaN).
- maximum
- minimum
Element-wise minimum of two arrays, propagating any NaNs.
- nanmax
The maximum value of an array along a given axis, ignoring any NaNs.
Aliases
-
numpy.nanmin