ak.argmin#
Defined in awkward.operations.ak_argmin on line 24.
- ak.argmin(array, axis=None, *, keepdims=False, mask_identity=True, highlevel=True, behavior=None, attrs=None)#
- Parameters:
array – Array-like data (anything
ak.to_layout
recognizes).axis (None or int) – If None, combine all values from the array into a single scalar result; if an int, group by that axis:
0
is the outermost,1
is the first level of nested lists, etc., and negativeaxis
counts from the innermost:-1
is the innermost,-2
is the next level up, etc.keepdims (bool) – If False, this reducer decreases the number of dimensions by 1; if True, the reduced values are wrapped in a new length-1 dimension so that the result of this operation may be broadcasted with the original array.
mask_identity (bool) – If True, reducing over empty lists results in None (an option type); otherwise, reducing over empty lists results in the operation’s identity.
highlevel (bool) – If True, return an
ak.Array
; otherwise, return a low-levelak.contents.Content
subclass.behavior (None or dict) – Custom
ak.behavior
for the output array, if high-level.attrs (None or dict) – Custom attributes for the output array, if high-level.
Returns the index position of the minimum value in each group of elements
from array
(many types supported, including all Awkward Arrays and
Records). The identity of minimization would be infinity, but argmin
must return the position of the minimum element, which has no value for
empty lists. Therefore, the identity should be masked: the argmin of
an empty list is None. If mask_identity=False
, the result would be -1
,
which is distinct from all valid index positions, but care should be taken
that it is not misinterpreted as “the last element of the list.”
This operation is the same as NumPy’s argmin if all lists at a given dimension have the same length and no None values, but it generalizes to cases where they do not.
See ak.sum
for a more complete description of nested list and missing
value (None) handling in reducers.
See also ak.nanargmin
.