.. currentmodule:: cuquantum.bindings.custatevec

#################################################
cuStateVec (:mod:`cuquantum.bindings.custatevec`)
#################################################

Python objects & constants
##########################

Objects
*******

.. autosummary::
   :toctree: generated/

   SVSwapParameters

   :template: dataclass.rst

   sv_swap_parameters_dtype

Enums and constants
*******************

.. autosummary::
   :toctree: generated/

   Pauli
   MatrixLayout
   MatrixType
   MatrixMapType
   CollapseOp
   SamplerOutput
   DeviceNetworkType
   StateVectorType
   MathMode
   CommunicatorType
   DataTransferType


Python functions
################

Library management
******************

Handle management API
=====================

.. autosummary::
   :toctree: generated/

   create
   destroy
   get_default_workspace_size
   set_workspace

CUDA stream management API
==========================

.. autosummary::
   :toctree: generated/

   set_stream
   get_stream

Logger API
==========

.. autosummary::
   :toctree: generated/

   logger_set_callback_data
   logger_open_file
   logger_set_level
   logger_set_mask
   logger_force_disable

Memory management API
=====================

.. autosummary::
   :toctree: generated/

   set_device_mem_handler
   get_device_mem_handler

Versioning API
==============

.. autosummary::
   :toctree: generated/

   get_property
   get_version

Math mode API
=============

.. autosummary::
   :toctree: generated/

   set_math_mode
   get_math_mode


State vector initialization
***************************

.. autosummary::
   :toctree: generated/

   initialize_state_vector


Gate application
****************

General matrices
================

.. autosummary::
   :toctree: generated/

   apply_matrix_get_workspace_size
   apply_matrix
   apply_matrix_batched_get_workspace_size
   apply_matrix_batched

Pauli matrices
==============

.. autosummary::
   :toctree: generated/

   apply_pauli_rotation

Generalized permutation matrices
================================

.. autosummary::
   :toctree: generated/

   apply_generalized_permutation_matrix_get_workspace_size
   apply_generalized_permutation_matrix


Measurement
***********

Measurement on Z-bases
======================

.. autosummary::
   :toctree: generated/

   abs2sum_on_z_basis
   collapse_on_z_basis
   measure_on_z_basis

Qubit measurement
=================

.. autosummary::
   :toctree: generated/

   abs2sum_array
   collapse_by_bit_string
   batch_measure
   abs2sum_array_batched
   collapse_by_bit_string_batched_get_workspace_size
   collapse_by_bit_string_batched
   measure_batched
   batch_measure_with_offset


Expectation
***********

Expectation via a matrix
========================

.. autosummary::
   :toctree: generated/

   compute_expectation_get_workspace_size
   compute_expectation
   compute_expectation_batched_get_workspace_size
   compute_expectation_batched

Expectation on Pauli basis
==========================

.. autosummary::
   :toctree: generated/

   compute_expectations_on_pauli_basis


Sampling
********

.. autosummary::
   :toctree: generated/

   sampler_create
   sampler_destroy
   sampler_preprocess
   sampler_sample
   sampler_get_squared_norm
   sampler_apply_sub_sv_offset


Accessor
********

.. autosummary::
   :toctree: generated/

   accessor_create
   accessor_create_view
   accessor_destroy
   accessor_set_extra_workspace
   accessor_get
   accessor_set


Single-process qubit reordering
*******************************

.. autosummary::
   :toctree: generated/

   swap_index_bits
   multi_device_swap_index_bits


Multi-process qubit reordering
******************************

.. autosummary::
   :toctree: generated/

   communicator_create
   communicator_destroy

   dist_index_bit_swap_scheduler_create
   dist_index_bit_swap_scheduler_destroy
   dist_index_bit_swap_scheduler_set_index_bit_swaps
   dist_index_bit_swap_scheduler_get_parameters

   sv_swap_worker_create
   sv_swap_worker_destroy
   sv_swap_worker_set_extra_workspace
   sv_swap_worker_set_transfer_workspace
   sv_swap_worker_set_sub_svs_p2p
   sv_swap_worker_set_parameters
   sv_swap_worker_execute

Sub state vector migration
**************************

.. autosummary::
   :toctree: generated/

   sub_sv_migrator_create
   sub_sv_migrator_destroy
   sub_sv_migrator_migrate

Test gate matrix type
*********************

.. autosummary::
   :toctree: generated/

   test_matrix_type_get_workspace_size
   test_matrix_type