unique_all¶
- unique_all(x: array, /) Tuple[array, array, array, array] ¶
Returns the unique elements of an input array
x
, the first occurring indices for each unique element inx
, the indices from the set of unique elements that reconstructx
, and the corresponding counts for each unique element inx
.Data-dependent output shape
The shapes of two of the output arrays for this function depend on the data values in the input array; hence, array libraries which build computation graphs (e.g., JAX, Dask, etc.) may find this function difficult to implement without knowing array values. Accordingly, such libraries may choose to omit this function. See Data-dependent output shapes section for more details.
Note
Uniqueness should be determined based on value equality (see
equal()
). For input arrays having floating-point data types, value-based equality implies the following behavior.As
nan
values compare asFalse
,nan
values should be considered distinct.As complex floating-point values having at least one
nan
component compare asFalse
, complex floating-point values havingnan
components should be considered distinct.As
-0
and+0
compare asTrue
, signed zeros should not be considered distinct, and the corresponding unique element will be implementation-dependent (e.g., an implementation could choose to return-0
if-0
occurs before+0
).
As signed zeros are not distinct, using
inverse_indices
to reconstruct the input array is not guaranteed to return an array having the exact same values.Each
nan
value and each complex floating-point value having anan
component should have a count of one, while the counts for signed zeros should be aggregated as a single count.- Parameters:
x (array) – input array. If
x
has more than one dimension, the function must flattenx
and return the unique elements of the flattened array.- Returns:
out (Tuple[array, array, array, array]) – a namedtuple
(values, indices, inverse_indices, counts)
whosefirst element must have the field name
values
and must be a one-dimensional array containing the unique elements ofx
. The array must have the same data type asx
.second element must have the field name
indices
and must be an array containing the indices (first occurrences) of a flattenedx
that result invalues
. The array must have the same shape asvalues
and must have the default array index data type.third element must have the field name
inverse_indices
and must be an array containing the indices ofvalues
that reconstructx
. The array must have the same shape asx
and must have the default array index data type.fourth element must have the field name
counts
and must be an array containing the number of times each unique element occurs inx
. The order of the returned counts must match the order ofvalues
, such that a specific element incounts
corresponds to the respective unique element invalues
. The returned array must have same shape asvalues
and must have the default array index data type.
Note
The order of unique elements is not specified and may vary between implementations.
Notes
Changed in version 2022.12: Added complex data type support.
Changed in version 2023.12: Clarified flattening behavior and required the order of
counts
match the order ofvalues
.