Set Functions ¶
Array API specification for creating and operating on sets.
A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.

Positional parameters must be positionalonly parameters. Positionalonly parameters have no externallyusable name. When a function accepting positionalonly parameters is called, positional arguments are mapped to these parameters based solely on their order.

Optional parameters must be keywordonly arguments.

Unless stated otherwise, functions must support the data types defined in Data Types .
Objects in API ¶
unique_all(x, /) ¶
Datadependent 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 Datadependent output shapes section for more details.
Returns the unique elements of an input array
x
.
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)
whose
first element must have the field name
values
and must be an 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) ofx
that result invalues
. The array must have the same shape asvalues
and must have the default integer 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 integer 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 returned array must have same shape asvalues
and must have the default integer data type.
Note
The order of unique elements is not specified and may vary between implementations.


unique_inverse(x, /) ¶
Returns the unique elements of an input array
x
and the indices from the set of unique elements that reconstruct
x
.
Datadependent output shape
The shape of one of the output arrays for this function depends 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 Datadependent output shapes section for more details.
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> ]

a namedtuple
(values, inverse_indices)
whose
first element must have the field name
values
and must be an array containing the unique elements ofx
. The array must have the same data type asx
. 
second 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 have the default integer data type.
Note
The order of unique elements is not specified and may vary between implementations.


unique_values(x, /) ¶
Datadependent output shape
The shape of the output array for this function depends 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 Datadependent output shapes section for more details.
Returns the unique elements of an input array
x
.
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 : <array>

an array containing the set of unique elements in
x
. The returned array must have the same data type asx
.Note
The order of unique elements is not specified and may vary between implementations.
