.. |nbsp| unicode:: 0xA0
   :trim:

*********************
cuStateVec data types
*********************

======================
Opaque data structures
======================

-------------------------
:code:`custatevecIndex_t`
-------------------------

.. doxygentypedef:: custatevecIndex_t

--------------------------
:code:`custatevecHandle_t`
--------------------------

.. doxygentypedef:: custatevecHandle_t

-------------------------------------
:code:`custatevecSamplerDescriptor_t`
-------------------------------------

.. doxygentypedef:: custatevecSamplerDescriptor_t

--------------------------------------
:code:`custatevecAccessorDescriptor_t`
--------------------------------------

.. doxygentypedef:: custatevecAccessorDescriptor_t

.. _custatevecLoggerCallback_t-label:

----------------------------------
:code:`custatevecLoggerCallback_t`
----------------------------------

.. doxygentypedef:: custatevecLoggerCallback_t

--------------------------------------
:code:`custatevecLoggerCallbackData_t`
--------------------------------------

.. doxygentypedef:: custatevecLoggerCallbackData_t

.. _custatevecDeviceMemHandler_t-label:

------------------------------------
:code:`custatevecDeviceMemHandler_t`
------------------------------------

.. doxygenstruct:: custatevecDeviceMemHandler_t
   :members:

.. _custatevecCommunicatorDescriptor_t-label:

------------------------------------------
:code:`custatevecCommunicatorDescriptor_t`
------------------------------------------

.. doxygentypedef:: custatevecCommunicatorDescriptor_t

.. _custatevecDistIndexBitSwapSchedulerDescriptor_t-label:

-------------------------------------------------------
:code:`custatevecDistIndexBitSwapSchedulerDescriptor_t`
-------------------------------------------------------

.. doxygentypedef:: custatevecDistIndexBitSwapSchedulerDescriptor_t

.. _custatevecSVSwapWorkerDescriptor_t-label:

------------------------------------------
:code:`custatevecSVSwapWorkerDescriptor_t`
------------------------------------------

.. doxygentypedef:: custatevecSVSwapWorkerDescriptor_t

.. _custatevecSVSwapParameters_t-label:

------------------------------------
:code:`custatevecSVSwapParameters_t`
------------------------------------

.. doxygenstruct:: custatevecSVSwapParameters_t
   :members:


.. _custatevecSubSVMigratorDescriptor_t-label:

-------------------------------------------
:code:`custatevecSubSVMigratorDescriptor_t`
-------------------------------------------

.. doxygentypedef:: custatevecSubSVMigratorDescriptor_t

----

.. _CUSTATEVEC_ALLOCATOR_NAME_LEN-label:

-------------------------------------
:code:`CUSTATEVEC_ALLOCATOR_NAME_LEN`
-------------------------------------

.. doxygendefine:: CUSTATEVEC_ALLOCATOR_NAME_LEN

----

.. _CUSTATEVEC_MAX_SEGMENT_MASK_SIZE-label:

----------------------------------------
:code:`CUSTATEVEC_MAX_SEGMENT_MASK_SIZE`
----------------------------------------

.. doxygendefine:: CUSTATEVEC_MAX_SEGMENT_MASK_SIZE

----

===========
Enumerators
===========

.. _custatevecStatus_t-label:

--------------------------
:code:`custatevecStatus_t`
--------------------------

.. doxygenenum:: custatevecStatus_t

----

.. _custatevecPauli_t-label:

-------------------------
:code:`custatevecPauli_t`
-------------------------

.. doxygenenum:: custatevecPauli_t

----

.. _custatevecMatrixLayout_t-label:

--------------------------------
:code:`custatevecMatrixLayout_t`
--------------------------------

.. doxygenenum:: custatevecMatrixLayout_t

----

.. _custatevecMatrixType_t-label:

------------------------------
:code:`custatevecMatrixType_t`
------------------------------

.. doxygenenum:: custatevecMatrixType_t

----

.. _custatevecMatrixMapType_t-label:

---------------------------------
:code:`custatevecMatrixMapType_t`
---------------------------------

.. doxygenenum:: custatevecMatrixMapType_t

----

.. _custatevecCollapseOp_t-label:

------------------------------
:code:`custatevecCollapseOp_t`
------------------------------

.. doxygenenum:: custatevecCollapseOp_t

----

.. _custatevecComputeType_t-label:

-------------------------------
:code:`custatevecComputeType_t`
-------------------------------

.. doxygenenum:: custatevecComputeType_t

----

.. _custatevecSamplerOutput_t-label:

---------------------------------
:code:`custatevecSamplerOutput_t`
---------------------------------

.. doxygenenum:: custatevecSamplerOutput_t

----

.. _custatevecDeviceNetworkType_t-label:

-------------------------------------
:code:`custatevecDeviceNetworkType_t`
-------------------------------------

.. doxygenenum:: custatevecDeviceNetworkType_t

----

.. _custatevecStateVectorType_t-label:

-----------------------------------
:code:`custatevecStateVectorType_t`
-----------------------------------

.. doxygenenum:: custatevecStateVectorType_t

----

.. _custatevecMathMode_t-label:

----------------------------
:code:`custatevecMathMode_t`
----------------------------

.. doxygenenum:: custatevecMathMode_t

----

.. _custatevecCommunicatorType_t-label:

------------------------------------
:code:`custatevecCommunicatorType_t`
------------------------------------

.. doxygenenum:: custatevecCommunicatorType_t

----

.. _custatevecDataTransferType_t-label:

------------------------------------
:code:`custatevecDataTransferType_t`
------------------------------------

.. doxygenenum:: custatevecDataTransferType_t