xorbits.numpy.nanargmin#

xorbits.numpy.nanargmin(a, axis=None, out=None, combine_size=None)[source]#

Return the indices of the minimum values in the specified axis ignoring NaNs. For all-NaN slices ValueError is raised. Warning: the results cannot be trusted if a slice contains only NaNs and Infs.

Parameters

  • a (array_like) – Input data.

  • axis (int, optional) – Axis along which to operate. By default flattened input is used.

  • out (array, optional) –

    If provided, the result will be inserted into this array. It should be of the appropriate shape and dtype.

    New in version 1.22.0(numpy).

  • keepdims (bool, optional (Not supported yet)) –

    If 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 array.

    New in version 1.22.0(numpy).

Returns

index_array – An array of indices or a single index value.

Return type

ndarray

See also

argmin, nanargmax

Examples

>>> a = np.array([[np.nan, 4], [2, 3]])  
>>> np.argmin(a)  
0
>>> np.nanargmin(a)  
2
>>> np.nanargmin(a, axis=0)  
array([1, 1])
>>> np.nanargmin(a, axis=1)  
array([1, 0])
combine_size: int, optional

The number of chunks to combine.

This docstring was copied from numpy.