.. currentmodule:: cuquantum

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

Objects
*******

.. autosummary::
   :toctree: generated/

   Network
   BaseCUDAMemoryManager
   MemoryPointer
   CircuitToEinsum

   :template: dataclass.rst

   NetworkOptions
   OptimizerInfo
   OptimizerOptions
   PathFinderOptions
   ReconfigOptions
   SlicerOptions
   

Enums
*****

Here is a collection of enums supported by both :mod:`~cuquantum.custatevec` and :mod:`~cuquantum.cutensornet` modules.

.. warning::
   In a future release, enums exposed here will be deprecated and removed in favor of those
   imported from CUDA Python.

.. autosummary::
   :toctree: generated/

   ComputeType
   cudaDataType
   libraryPropertyType


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

.. autosummary::
   :toctree: generated/

   contract
   contract_path
   einsum
   einsum_path

.. _python cmdline support:

Command Line Support
####################

The outputs of ``python -m cuquantum`` can be used in your build system to help discover the location of
binaries used by cuQuantum Python.

.. program-output:: python -m cuquantum
   :returncode: 1