cuStabilizer (cuquantum.bindings.custabilizer)

Python objects & constants

Objects

cuStabilizerError(status)

Enums

Status(value)

Status codes returned by the cuStabilizer library.

Python functions

Versioning API

get_version()	Returns the semantic version number of the cuStabilizer library.
get_error_string(int status)	Get the description string for a given cuStabilizer status code.

Handle management API

create()	Create and initialize the library context.
destroy(intptr_t handle)	Destroy the library context.

Circuit API

circuit_size_from_string(intptr_t handle, ...)	Returns the size of the device buffer required for a circuit.
create_circuit_from_string(intptr_t handle, ...)	Create a new circuit from a string representation.
destroy_circuit(intptr_t circuit)	Destroy a circuit.

Frame Simulator API

create_frame_simulator(intptr_t handle, ...)	Create a FrameSimulator.
destroy_frame_simulator(intptr_t frame_simulator)	Destroy the FrameSimulator.
frame_simulator_apply_circuit(...)	Run Pauli frame simulation using the circuit.

Rng API

sample_prob_array(intptr_t handle, ...)	Sample Bernoulli random bits from a probability array.
sample_prob_array_sparse_prepare(...)	Query the device workspace size required for sparse Bernoulli sampling.
sample_prob_array_sparse_compute(...)	Sample Bernoulli random bits from a probability array and return a CSR matrix.

Linear Algebra API

gf2_sparse_dense_matrix_multiply(...)	compute GF(2) sparse-dense matrix multiplication c = A @ b.
gf2_sparse_sparse_matrix_multiply(...)	compute GF(2) sparse-sparse matrix multiplication c = A @ B.