Utility APIs

Under cuquantum, shared utility APIs are provided to facilitate seamless integration and usage across various modules of the cuquantum-python library.

API reference

Python objects & constants

Objects

BaseCUDAMemoryManager(device_id, logger)	Protocol for memory manager plugins.
MemoryPointer(device_ptr, size, finalizer)	An RAII class for a device memory buffer.
MemoryLimitExceeded(limit, requirement, ...)	This exception is raised when the operation requires more device memory than what was specified in operation options.

Enums

Here is a collection of enums supported by cuquantum.bindings.cudensitymat, cuquantum.bindings.custatevec and cuquantum.bindings.cutensornet modules.

Warning

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

ComputeType(value)	An enumeration of CUDA compute types.
cudaDataType(value)	An enumeration of cudaDataType_t.
libraryPropertyType(value)	An enumeration of library version information.