cirq_superstaq.circuits
=======================

.. py:module:: cirq_superstaq.circuits


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/cirq_superstaq/circuits/msd/index


Functions
---------

.. autoapisummary::

   cirq_superstaq.circuits.msd_15_to_1
   cirq_superstaq.circuits.msd_5_to_1
   cirq_superstaq.circuits.msd_7_to_1


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

.. py:function:: msd_15_to_1(qubits: collections.abc.Sequence[cirq.Qid]) -> cirq.Circuit

   Function to perform a 15-to-1 magic state distillation protocol.
       Reference: https://arxiv.org/abs/1208.0928 Page 38 Figure 33.

   :param qubits: The list of LineQubits of length 16.
                  The last qubit will be the final magic state qubit.

   :returns: The magic state distillation circuit.


.. py:function:: msd_5_to_1(qubits: collections.abc.Sequence[cirq.Qid]) -> cirq.Circuit

   Function to perform a 5-to-1 magic state distillation protocol.

   Reference: https://arxiv.org/abs/2310.12106 Page 4 Figure 1.

   :param qubits: A list of qubits to use in the circuit, where the first qubit will
                  be the final magic state qubit.

   :returns: The magic state distillation circuit.


.. py:function:: msd_7_to_1(qubits: collections.abc.Sequence[cirq.Qid]) -> cirq.Circuit

   Function to perform a 7-to-1 magic state distillation protocol.
       Reference: https://arxiv.org/abs/0803.0272 Page 12 Figure 19.

   :param qubits: The list of `cirq.LineQubit` of length 8. The first qubit
                  in the list will be the final magic state qubit.

   :returns: The magic state distillation circuit.