:py:mod:`qulacs_worker`
=======================

.. py:module:: qulacs_worker

.. autodoc2-docstring:: qulacs_worker
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`get_backend <qulacs_worker.get_backend>`
     - .. autodoc2-docstring:: qulacs_worker.get_backend
          :summary:
   * - :py:obj:`get_config <qulacs_worker.get_config>`
     - .. autodoc2-docstring:: qulacs_worker.get_config
          :summary:
   * - :py:obj:`get_compiled_circuit <qulacs_worker.get_compiled_circuit>`
     - .. autodoc2-docstring:: qulacs_worker.get_compiled_circuit
          :summary:
   * - :py:obj:`run_circuit <qulacs_worker.run_circuit>`
     - .. autodoc2-docstring:: qulacs_worker.run_circuit
          :summary:
   * - :py:obj:`run_circuits <qulacs_worker.run_circuits>`
     - .. autodoc2-docstring:: qulacs_worker.run_circuits
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`worker <qulacs_worker.worker>`
     - .. autodoc2-docstring:: qulacs_worker.worker
          :summary:

API
~~~

.. py:data:: worker
   :canonical: qulacs_worker.worker
   :value: 'Worker(...)'

   .. autodoc2-docstring:: qulacs_worker.worker

.. py:function:: get_backend(result_type: str = 'state_vector', gpu_sim: bool = False) -> pytket.backends.backend.Backend
   :canonical: qulacs_worker.get_backend

   .. autodoc2-docstring:: qulacs_worker.get_backend

.. py:function:: get_config(seed: int | None = None) -> dict[str, typing.Any]
   :canonical: qulacs_worker.get_config

   .. autodoc2-docstring:: qulacs_worker.get_config

.. py:function:: get_compiled_circuit(circuit: pytket._tket.circuit.Circuit, optimisation_level: int = 2, result_type: str = 'state_vector', gpu_sim: bool = False) -> pytket._tket.circuit.Circuit
   :canonical: qulacs_worker.get_compiled_circuit

   .. autodoc2-docstring:: qulacs_worker.get_compiled_circuit

.. py:function:: run_circuit(circuit: pytket._tket.circuit.Circuit, n_shots: int, result_type: str = 'state_vector', gpu_sim: bool = False, seed: int | None = None) -> pytket.backends.backendresult.BackendResult
   :canonical: qulacs_worker.run_circuit

   .. autodoc2-docstring:: qulacs_worker.run_circuit

.. py:function:: run_circuits(circuits: list[pytket._tket.circuit.Circuit], n_shots: list[int], result_type: str = 'state_vector', gpu_sim: bool = False, seed: int | None = None) -> list[pytket.backends.backendresult.BackendResult]
   :canonical: qulacs_worker.run_circuits

   .. autodoc2-docstring:: qulacs_worker.run_circuits