cirq_superstaq.validation
=========================

.. py:module:: cirq_superstaq.validation


Attributes
----------

.. autoapisummary::

   cirq_superstaq.validation.SUPPORTED_QID_TYPES


Functions
---------

.. autoapisummary::

   cirq_superstaq.validation.validate_cirq_circuits
   cirq_superstaq.validation.validate_qubit_types


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

.. py:function:: validate_cirq_circuits(circuits: object, require_measurements: bool = False) -> None

   Validates that the input is an acceptable `cirq-core` object for `cirq-superstaq`.

   In particular, this function verifies that `circuits` is either a single `cirq.Circuit`
   or a list of `cirq.Circuit` instances. Additionally, also validates that `circuits`
   contains supported qubit types only.

   :param circuits: The circuit(s) to run.
   :param require_measurements: An optional boolean flag to check if all of the circuits have
                                measurements.

   :raises ValueError: If the input is not a `cirq.Circuit` or a list of `cirq.Circuit` instances.
   :raises TypeError: If an unsupported qubit type is found in `circuits`.


.. py:function:: validate_qubit_types(circuits: cirq.Circuit | collections.abc.Sequence[cirq.Circuit]) -> None

   Verifies that `circuits` consists of valid (`cirq-core`) qubit types only.

   :param circuits: The input circuit(s) to validate.

   :raises TypeError: If an unsupported qubit type is found in `circuits`.


.. py:data:: SUPPORTED_QID_TYPES