.. currentmodule:: cuquantum.bindings.cudensitymat

#####################################################
cuDensityMat (:mod:`cuquantum.bindings.cudensitymat`)
#####################################################

Python objects & constants
**************************

Types
=====

.. autosummary::
   :toctree: generated/

   ArrayType
   ScalarCallbackType
   TensorCallbackType
   ScalarGradientCallbackType
   TensorGradientCallbackType

Objects
=======

.. autosummary::
   :toctree: generated/

   WrappedScalarCallback
   WrappedTensorCallback
   WrappedScalarGradientCallback
   WrappedTensorGradientCallback

Enums
=====

.. autosummary::
   :toctree: generated/

   Status
   DistributedProvider
   CallbackDevice
   DifferentiationDir
   StatePurity
   ElementaryOperatorSparsity
   Memspace
   WorkspaceKind
   OperatorSpectrumKind
   OperatorSpectrumConfig

Functions
*********

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

.. autosummary::
   :toctree: generated/

   create
   destroy
   reset_distributed_configuration
   get_num_ranks
   get_proc_rank
   reset_random_seed


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

.. autosummary::
   :toctree: generated/

   create_workspace
   destroy_workspace
   workspace_get_memory_size
   workspace_set_memory
   workspace_get_memory


Operator API
============

.. autosummary::
   :toctree: generated/

   create_elementary_operator
   create_elementary_operator_batch
   destroy_elementary_operator

   create_matrix_operator_dense_local
   create_matrix_operator_dense_local_batch
   destroy_matrix_operator
   
   create_operator_term
   destroy_operator_term
   operator_term_append_elementary_product
   operator_term_append_elementary_product_batch
   operator_term_append_matrix_product
   operator_term_append_matrix_product_batch
   
   create_operator
   destroy_operator
   operator_append_term
   operator_append_term_batch
   operator_prepare_action
   operator_compute_action
   operator_prepare_action_backward_diff
   operator_compute_action_backward_diff
   
   create_operator_action
   destroy_operator_action
   operator_action_prepare
   operator_action_compute


Quantum state API
=================

.. autosummary::
   :toctree: generated/

   create_state
   destroy_state
   state_get_num_components
   state_get_component_storage_size
   state_attach_component_storage
   state_get_component_num_modes
   state_get_component_info
   state_initialize_zero
   state_compute_scaling
   state_compute_norm
   state_compute_trace
   state_compute_accumulation
   state_compute_inner_product


Expectation API
===============

.. autosummary::
   :toctree: generated/

   create_expectation
   destroy_expectation
   expectation_prepare
   expectation_compute


Operator eigenspectrum API
===========================

.. autosummary::
   :toctree: generated/

   create_operator_spectrum
   destroy_operator_spectrum
   operator_spectrum_configure
   operator_spectrum_prepare
   operator_spectrum_compute

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

.. autosummary::
   :toctree: generated/

   get_version