supermarq.converters
====================

.. py:module:: supermarq.converters


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/supermarq/converters/qiskit/index


Functions
---------

.. autoapisummary::

   supermarq.converters.cirq_gate_to_qiskit_gate
   supermarq.converters.cirq_to_qiskit
   supermarq.converters.qiskit_to_cirq


Package Contents
----------------

.. py:function:: cirq_gate_to_qiskit_gate(cirq_gate: cirq.Gate) -> qiskit.circuit.Gate

   Convert a single `cirq.Gate` to a qiskit Gate.


.. py:function:: cirq_to_qiskit(cirq_circuit: cirq.Circuit, qubits: collections.abc.Sequence[cirq.Qid]) -> qiskit.QuantumCircuit

   Converts `cirq.Circuit` into a `qiskit.QuantumCircuit` with a single qubit register.

   Note: Qubits in the qiskit circuit are ordered according to the given qubits sequence
   (i.e. n-th qubit in `qiskit_circuit.qubits` = n-th qubit in sequence).

   :param cirq_circuit: The circuit to convert into `qiskit`.
   :param qubits: The qubits belonging to `cirq_circuit`.

   :returns: The `qiskit` equivalent of `cirq_circuit`.


.. py:function:: qiskit_to_cirq(qiskit_circuit: qiskit.QuantumCircuit, keep_global_phase: bool = False) -> cirq.Circuit

   Converts a `qiskit.QuantumCircuit` to a `cirq.Circuit`, preserving global phase.

   :param qiskit_circuit: The circuit to convert into `cirq`.
   :param keep_global_phase: Boolean flag to preserve the global phase of the circuit. Defaults to
                             `False`.

   :returns: The `cirq` equivalent circuit of `qiskit_circuit`.