.. 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

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

.. autosummary::
   :toctree: generated/

   get_property
   get_version


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

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

.. autosummary::
   :toctree: generated/

   apply_matrix_buffer_size
   apply_matrix

Pauli Matrices
==============

.. autosummary::
   :toctree: generated/

   apply_exp

Generalized Permutation Matrices
================================

.. autosummary::
   :toctree: generated/

   apply_generalized_permutation_matrix_buffer_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


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

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

.. autosummary::
   :toctree: generated/

   expectation_buffer_size
   expectation
   expectations_on_pauli_basis


Sampling
********

.. autosummary::
   :toctree: generated/

   sampler_create
   sampler_destroy
   sampler_preprocess
   sampler_sample


Accessor
********

.. autosummary::
   :toctree: generated/

   accessor_create
   accessor_create_readonly
   accessor_destroy
   accessor_set_extra_workspace
   accessor_get
   accessor_set