:py:mod:`pytket_worker.stubs`
=============================

.. py:module:: pytket_worker.stubs

.. autodoc2-docstring:: pytket_worker.stubs
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`add_measure_all <pytket_worker.stubs.add_measure_all>`
     - .. autodoc2-docstring:: pytket_worker.stubs.add_measure_all
          :summary:
   * - :py:obj:`append_pauli_measurement_impl <pytket_worker.stubs.append_pauli_measurement_impl>`
     - .. autodoc2-docstring:: pytket_worker.stubs.append_pauli_measurement_impl
          :summary:
   * - :py:obj:`optimise_phase_gadgets <pytket_worker.stubs.optimise_phase_gadgets>`
     - .. autodoc2-docstring:: pytket_worker.stubs.optimise_phase_gadgets
          :summary:
   * - :py:obj:`apply_pass <pytket_worker.stubs.apply_pass>`
     - .. autodoc2-docstring:: pytket_worker.stubs.apply_pass
          :summary:
   * - :py:obj:`compile_circuit_quantinuum <pytket_worker.stubs.compile_circuit_quantinuum>`
     - .. autodoc2-docstring:: pytket_worker.stubs.compile_circuit_quantinuum
          :summary:
   * - :py:obj:`compile_circuits_quantinuum <pytket_worker.stubs.compile_circuits_quantinuum>`
     - .. autodoc2-docstring:: pytket_worker.stubs.compile_circuits_quantinuum
          :summary:
   * - :py:obj:`expectation <pytket_worker.stubs.expectation>`
     - .. autodoc2-docstring:: pytket_worker.stubs.expectation
          :summary:

API
~~~

.. py:class:: add_measure_all
   :canonical: pytket_worker.stubs.add_measure_all

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.add_measure_all

   .. py:attribute:: circuit
      :canonical: pytket_worker.stubs.add_measure_all.circuit
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.add_measure_all.circuit

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :canonical: pytket_worker.stubs.add_measure_all.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.add_measure_all.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.add_measure_all.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.add_measure_all.namespace

.. py:class:: append_pauli_measurement_impl
   :canonical: pytket_worker.stubs.append_pauli_measurement_impl

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.append_pauli_measurement_impl

   .. py:attribute:: circuit
      :canonical: pytket_worker.stubs.append_pauli_measurement_impl.circuit
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.append_pauli_measurement_impl.circuit

   .. py:attribute:: pauli_string
      :canonical: pytket_worker.stubs.append_pauli_measurement_impl.pauli_string
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.pauli.QubitPauliString]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.append_pauli_measurement_impl.pauli_string

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :canonical: pytket_worker.stubs.append_pauli_measurement_impl.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.append_pauli_measurement_impl.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.append_pauli_measurement_impl.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.append_pauli_measurement_impl.namespace

.. py:class:: optimise_phase_gadgets
   :canonical: pytket_worker.stubs.optimise_phase_gadgets

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.optimise_phase_gadgets

   .. py:attribute:: circuit
      :canonical: pytket_worker.stubs.optimise_phase_gadgets.circuit
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.optimise_phase_gadgets.circuit

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :canonical: pytket_worker.stubs.optimise_phase_gadgets.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.optimise_phase_gadgets.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.optimise_phase_gadgets.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.optimise_phase_gadgets.namespace

.. py:class:: apply_pass
   :canonical: pytket_worker.stubs.apply_pass

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.apply_pass

   .. py:attribute:: circuit
      :canonical: pytket_worker.stubs.apply_pass.circuit
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.apply_pass.circuit

   .. py:attribute:: compiler_pass
      :canonical: pytket_worker.stubs.apply_pass.compiler_pass
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.passes.BasePass]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.apply_pass.compiler_pass

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :canonical: pytket_worker.stubs.apply_pass.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.apply_pass.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.apply_pass.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.apply_pass.namespace

.. py:class:: compile_circuit_quantinuum
   :canonical: pytket_worker.stubs.compile_circuit_quantinuum

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.compile_circuit_quantinuum

   .. py:attribute:: circuit
      :canonical: pytket_worker.stubs.compile_circuit_quantinuum.circuit
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.compile_circuit_quantinuum.circuit

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :canonical: pytket_worker.stubs.compile_circuit_quantinuum.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.compile_circuit_quantinuum.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.compile_circuit_quantinuum.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.compile_circuit_quantinuum.namespace

.. py:class:: compile_circuits_quantinuum
   :canonical: pytket_worker.stubs.compile_circuits_quantinuum

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.compile_circuits_quantinuum

   .. py:attribute:: circuits
      :canonical: pytket_worker.stubs.compile_circuits_quantinuum.circuits
      :type: tierkreis.controller.data.models.TKR[list[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.compile_circuits_quantinuum.circuits

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[list[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]]
      :canonical: pytket_worker.stubs.compile_circuits_quantinuum.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.compile_circuits_quantinuum.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.compile_circuits_quantinuum.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.compile_circuits_quantinuum.namespace

.. py:class:: expectation
   :canonical: pytket_worker.stubs.expectation

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: pytket_worker.stubs.expectation

   .. py:attribute:: backend_result
      :canonical: pytket_worker.stubs.expectation.backend_result
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[pytket.backends.backendresult.BackendResult]]
      :value: None

      .. autodoc2-docstring:: pytket_worker.stubs.expectation.backend_result

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[float]]
      :canonical: pytket_worker.stubs.expectation.out
      :staticmethod:

      .. autodoc2-docstring:: pytket_worker.stubs.expectation.out

   .. py:property:: namespace
      :canonical: pytket_worker.stubs.expectation.namespace
      :type: str

      .. autodoc2-docstring:: pytket_worker.stubs.expectation.namespace