.. currentmodule:: cuquantum.custatevec

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

Enums
*****

.. autosummary::
   :toctree: generated/

   Pauli
   MatrixLayout
   MatrixType
   Collapse
   SamplerOutput


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


Gate Application
****************

General Matrices
================

.. autosummary::
   :toctree: generated/

   apply_matrix_get_workspace_size
   apply_matrix

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

Batched Single Qubit Measurement
================================

.. autosummary::
   :toctree: generated/

   abs2sum_array
   collapse_by_bitstring
   batch_measure
   batch_measure_with_offset


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

Expectation via a Matrix
========================

.. autosummary::
   :toctree: generated/

   compute_expectation_get_workspace_size
   compute_expectation

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


Qubit reordering
****************

.. autosummary::
   :toctree: generated/

   swap_index_bits


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

.. autosummary::
   :toctree: generated/

   test_matrix_type_get_workspace_size
   test_matrix_type