QXel.simulator.state_vector_simulator module

class QXel.simulator.state_vector_simulator.StateVectorSimulator

Bases: BaseSimulator

High-level entry point for state-vector simulation.

__init__()

Create a simulator with a reusable state-vector transpiler.

run(qubit_count, operations, results, *, shots=0, max_fusion=4, compute_type='cpu', data_type='complex128', offload_type='none', do_overlap=True, path=None)

Transpile and execute a circuit with the state-vector backend.

The simulator derives a local working-set size from available memory unless QXEL_QUBIT_COUNT_LOCAL is already defined in the environment.

Parameters:

  • qubit_count (int) – Total logical qubit count.

  • operations (list[Operator]) – Circuit operations in logical qubit order.

  • results (list[Result]) – Result descriptors to accumulate during the run.

  • shots (int, optional) – Number of measurement samples to draw.

  • max_fusion (int, optional) – Largest gate width generated by the fusion pass.

  • compute_type (str, optional) – Execution backend. Supported values include "cpu", "cuda", "cuquantum", and "quant".

  • data_type (str, optional) – Scalar storage type. Currently only "complex128" is accepted.

  • offload_type (str, optional) – Secondary storage tier used when the full state cannot stay resident in the compute buffer.

  • do_overlap (bool, optional) – Whether transfers and computation should be double-buffered when the backend supports it.

  • path (Optional[list[str] | str], optional) – Storage roots used for filesystem offloading.

Returns:

Materialized result payloads in the same order as results.

Return type:

list