Options#

class cuquantum.stabilizer.Options(
device_id: int = 0,
handle: Any | None = None,
logger: Logger | None = None,
allocator: BaseCUDAMemoryManager | None = None,
)[source]#

A data class for providing options to the Frame Simulator.

This class follows the design pattern used in cuTensorNet’s NetworkOptions for consistent user experience across the cuQuantum package.

device_id#

int CUDA device ordinal (default: 0). Device 0 will be used if not specified.

Type:

int

handle#

Optional[Any] cuStabilizer library handle. A handle will be created if one is not provided.

Type:

Any | None

logger#

Optional[Logger] Python Logger object. The root logger will be used if not provided.

Type:

logging.Logger | None

allocator#

Optional[BaseCUDAMemoryManager] An object that supports the BaseCUDAMemoryManager protocol, used to draw device memory. If not provided, cupy.cuda.alloc will be used.

Type:

nvmath.memory.BaseCUDAMemoryManager | None