cuDensityMat Functions
**********************

.. role::  raw-html(raw)
    :format: html

.. _cuDensityMat library context management API:

Library Context Management API
==============================

.. _cudensitymatCreate-label:

:code:`cudensitymatCreate`
--------------------------

.. doxygenfunction:: cudensitymatCreate

----

.. _cudensitymatDestroy-label:

:code:`cudensitymatDestroy`
---------------------------

.. doxygenfunction:: cudensitymatDestroy

----

.. _cudensitymatResetRandomSeed-label:

:code:`cudensitymatResetRandomSeed`
-----------------------------------

.. doxygenfunction:: cudensitymatResetRandomSeed

----

.. _cuDensityMat distributed parallelization API:

Distributed Parallelization API
===============================

.. _cudensitymatResetDistributedConfiguration-label:

:code:`cudensitymatResetDistributedConfiguration`
-------------------------------------------------

.. doxygenfunction:: cudensitymatResetDistributedConfiguration

----

.. _cudensitymatGetNumRanks-label:

:code:`cudensitymatGetNumRanks`
-------------------------------

.. doxygenfunction:: cudensitymatGetNumRanks

----

.. _cudensitymatGetProcRank-label:

:code:`cudensitymatGetProcRank`
-------------------------------

.. doxygenfunction:: cudensitymatGetProcRank

----

.. _cuDensityMat workspace management API:

Workspace Management API
========================

.. _cudensitymatCreateWorkspace-label:

:code:`cudensitymatCreateWorkspace`
-----------------------------------

.. doxygenfunction:: cudensitymatCreateWorkspace

----

.. _cudensitymatDestroyWorkspace-label:

:code:`cudensitymatDestroyWorkspace`
------------------------------------

.. doxygenfunction:: cudensitymatDestroyWorkspace

----

.. _cudensitymatWorkspaceGetMemorySize-label:

:code:`cudensitymatWorkspaceGetMemorySize`
------------------------------------------

.. doxygenfunction:: cudensitymatWorkspaceGetMemorySize

----

.. _cudensitymatWorkspaceSetMemory-label:

:code:`cudensitymatWorkspaceSetMemory`
--------------------------------------

.. doxygenfunction:: cudensitymatWorkspaceSetMemory

----

.. _cudensitymatWorkspaceGetMemory-label:

:code:`cudensitymatWorkspaceGetMemory`
--------------------------------------

.. doxygenfunction:: cudensitymatWorkspaceGetMemory

----

.. _cuDensityMat quantum state API:

Quantum State API
=================

.. _cudensitymatCreateState-label:

:code:`cudensitymatCreateState`
-------------------------------

.. doxygenfunction:: cudensitymatCreateState

----

.. _cudensitymatDestroyState-label:

:code:`cudensitymatDestroyState`
--------------------------------

.. doxygenfunction:: cudensitymatDestroyState

----

.. _cudensitymatStateGetNumComponents-label:

:code:`cudensitymatStateGetNumComponents`
-----------------------------------------

.. doxygenfunction:: cudensitymatStateGetNumComponents

----

.. _cudensitymatStateGetComponentStorageSize-label:

:code:`cudensitymatStateGetComponentStorageSize`
------------------------------------------------

.. doxygenfunction:: cudensitymatStateGetComponentStorageSize

----

.. _cudensitymatStateGetComponentNumModes-label:

:code:`cudensitymatStateGetComponentNumModes`
---------------------------------------------

.. doxygenfunction:: cudensitymatStateGetComponentNumModes

----

.. _cudensitymatStateGetComponentInfo-label:

:code:`cudensitymatStateGetComponentInfo`
-----------------------------------------

.. doxygenfunction:: cudensitymatStateGetComponentInfo

----

.. _cudensitymatStateAttachComponentStorage-label:

:code:`cudensitymatStateAttachComponentStorage`
-----------------------------------------------

.. doxygenfunction:: cudensitymatStateAttachComponentStorage

----

.. _cudensitymatStateInitializeZero-label:

:code:`cudensitymatStateInitializeZero`
---------------------------------------

.. doxygenfunction:: cudensitymatStateInitializeZero

----

.. _cudensitymatStateComputeScaling-label:

:code:`cudensitymatStateComputeScaling`
---------------------------------------

.. doxygenfunction:: cudensitymatStateComputeScaling

----

.. _cudensitymatStateComputeNorm-label:

:code:`cudensitymatStateComputeNorm`
------------------------------------

.. doxygenfunction:: cudensitymatStateComputeNorm

----

.. _cudensitymatStateComputeTrace-label:

:code:`cudensitymatStateComputeTrace`
-------------------------------------

.. doxygenfunction:: cudensitymatStateComputeTrace

----

.. _cudensitymatStateComputeAccumulation-label:

:code:`cudensitymatStateComputeAccumulation`
--------------------------------------------

.. doxygenfunction:: cudensitymatStateComputeAccumulation

----

.. _cudensitymatStateComputeInnerProduct-label:

:code:`cudensitymatStateComputeInnerProduct`
--------------------------------------------

.. doxygenfunction:: cudensitymatStateComputeInnerProduct

----

.. _cuDensityMat quantum operator API:

Quantum Operator API
====================

.. _cudensitymatCreateElementaryOperator-label:

:code:`cudensitymatCreateElementaryOperator`
--------------------------------------------

.. doxygenfunction:: cudensitymatCreateElementaryOperator

----

.. _cudensitymatDestroyElementaryOperator-label:

:code:`cudensitymatDestroyElementaryOperator`
---------------------------------------------

.. doxygenfunction:: cudensitymatDestroyElementaryOperator

----

.. _cudensitymatCreateOperatorTerm-label:

:code:`cudensitymatCreateOperatorTerm`
--------------------------------------

.. doxygenfunction:: cudensitymatCreateOperatorTerm

----

.. _cudensitymatDestroyOperatorTerm-label:

:code:`cudensitymatDestroyOperatorTerm`
---------------------------------------

.. doxygenfunction:: cudensitymatDestroyOperatorTerm

----

.. _cudensitymatOperatorTermAppendElementaryProduct-label:

:code:`cudensitymatOperatorTermAppendElementaryProduct`
-------------------------------------------------------

.. doxygenfunction:: cudensitymatOperatorTermAppendElementaryProduct

----

.. _cudensitymatOperatorTermAppendGeneralProduct-label:

:code:`cudensitymatOperatorTermAppendGeneralProduct`
----------------------------------------------------

.. doxygenfunction:: cudensitymatOperatorTermAppendGeneralProduct

----

.. _cudensitymatCreateOperator-label:

:code:`cudensitymatCreateOperator`
----------------------------------

.. doxygenfunction:: cudensitymatCreateOperator

----

.. _cudensitymatDestroyOperator-label:

:code:`cudensitymatDestroyOperator`
-----------------------------------

.. doxygenfunction:: cudensitymatDestroyOperator

----

.. _cudensitymatOperatorAppendTerm-label:

:code:`cudensitymatOperatorAppendTerm`
--------------------------------------

.. doxygenfunction:: cudensitymatOperatorAppendTerm

----

.. _cudensitymatOperatorPrepareAction-label:

:code:`cudensitymatOperatorPrepareAction`
-----------------------------------------

.. doxygenfunction:: cudensitymatOperatorPrepareAction

----

.. _cudensitymatOperatorComputeAction-label:

:code:`cudensitymatOperatorComputeAction`
-----------------------------------------

.. doxygenfunction:: cudensitymatOperatorComputeAction

----

.. _cudensitymatCreateOperatorAction-label:

:code:`cudensitymatCreateOperatorAction`
----------------------------------------

.. doxygenfunction:: cudensitymatCreateOperatorAction

----

.. _cudensitymatDestroyOperatorAction-label:

:code:`cudensitymatDestroyOperatorAction`
-----------------------------------------

.. doxygenfunction:: cudensitymatDestroyOperatorAction

----

.. _cudensitymatOperatorActionPrepare-label:

:code:`cudensitymatOperatorActionPrepare`
-----------------------------------------

.. doxygenfunction:: cudensitymatOperatorActionPrepare

----

.. _cudensitymatOperatorActionCompute-label:

:code:`cudensitymatOperatorActionCompute`
-----------------------------------------

.. doxygenfunction:: cudensitymatOperatorActionCompute

----

.. _cuDensityMat operator expectation API:

Operator Expectation API
========================

.. _cudensitymatCreateExpectation-label:

:code:`cudensitymatCreateExpectation`
-------------------------------------

.. doxygenfunction:: cudensitymatCreateExpectation

----

.. _cudensitymatDestroyExpectation-label:

:code:`cudensitymatDestroyExpectation`
--------------------------------------

.. doxygenfunction:: cudensitymatDestroyExpectation

----

.. _cudensitymatExpectationPrepare-label:

:code:`cudensitymatExpectationPrepare`
--------------------------------------

.. doxygenfunction:: cudensitymatExpectationPrepare

----

.. _cudensitymatExpectationCompute-label:

:code:`cudensitymatExpectationCompute`
--------------------------------------

.. doxygenfunction:: cudensitymatExpectationCompute