arkouda.array_api.set_functions
===============================

.. py:module:: arkouda.array_api.set_functions


Classes
-------

.. autoapisummary::

   arkouda.array_api.set_functions.UniqueAllResult
   arkouda.array_api.set_functions.UniqueCountsResult
   arkouda.array_api.set_functions.UniqueInverseResult


Functions
---------

.. autoapisummary::

   arkouda.array_api.set_functions.unique_all
   arkouda.array_api.set_functions.unique_counts
   arkouda.array_api.set_functions.unique_inverse
   arkouda.array_api.set_functions.unique_values


Module Contents
---------------

.. py:class:: UniqueAllResult

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: counts
      :type:  arkouda.array_api.array_object.Array


   .. py:attribute:: indices
      :type:  arkouda.array_api.array_object.Array


   .. py:attribute:: inverse_indices
      :type:  arkouda.array_api.array_object.Array


   .. py:attribute:: values
      :type:  arkouda.array_api.array_object.Array


.. py:class:: UniqueCountsResult

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: counts
      :type:  arkouda.array_api.array_object.Array


   .. py:attribute:: values
      :type:  arkouda.array_api.array_object.Array


.. py:class:: UniqueInverseResult

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: inverse_indices
      :type:  arkouda.array_api.array_object.Array


   .. py:attribute:: values
      :type:  arkouda.array_api.array_object.Array


.. py:function:: unique_all(x: arkouda.array_api.array_object.Array, /) -> UniqueAllResult

   Return a tuple of arrays containing:
   - the unique values in `x`
   - the indices of the first occurrence of each unique value
   - the inverse indices that reconstruct `x` from the unique values
   - the counts of each unique value


.. py:function:: unique_counts(x: arkouda.array_api.array_object.Array, /) -> UniqueCountsResult

   Return a tuple of arrays containing:
   - the unique values in `x`
   - the counts of each unique value


.. py:function:: unique_inverse(x: arkouda.array_api.array_object.Array, /) -> UniqueInverseResult

   Return a tuple of arrays containing:
   - the unique values in `x`
   - the inverse indices that reconstruct `x` from the unique values


.. py:function:: unique_values(x: arkouda.array_api.array_object.Array, /) -> arkouda.array_api.array_object.Array

   Return an array containing the unique values from `x`.