cirq_superstaq.resource_counters
================================

.. py:module:: cirq_superstaq.resource_counters

.. autoapi-nested-parse::

   Methods to count resources in a circuit.



Functions
---------

.. autoapisummary::

   cirq_superstaq.resource_counters.num_category_ops
   cirq_superstaq.resource_counters.num_global_ops
   cirq_superstaq.resource_counters.num_phased_xpow_subgates
   cirq_superstaq.resource_counters.num_single_qubit_gates
   cirq_superstaq.resource_counters.num_two_qubit_gates
   cirq_superstaq.resource_counters.total_global_rgate_pi_time


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

.. py:function:: num_category_ops(category_classifier: collections.abc.Callable[[cirq.Operation], bool], circuit: cirq.Circuit) -> int

   Computes the number of operations in a circuit that belong to a category.

   :param category_classifier: A `Callable` that returns true if the given operation has
                               certain features.
   :param circuit: A Cirq circuit.

   :returns: A number representing how many operations in the given circuit
             match the category classifier's conditions.


.. py:function:: num_global_ops(circuit: cirq.Circuit) -> int

   Get number of global operations in a circuit.

   :param circuit: A Cirq circuit.

   :returns: Number of global operations.


.. py:function:: num_phased_xpow_subgates(circuit: cirq.Circuit) -> int

   Get number of non-diagonal single qubit gates in a circuit.

   :param circuit: A Cirq circuit.

   Results:
       Number of non-diagonal single qubit gates.


.. py:function:: num_single_qubit_gates(circuit: cirq.Circuit) -> int

   Get number of single qubit gates in a circuit.

   :param circuit: A Cirq circuit.

   :returns: Number of single qubit gates.


.. py:function:: num_two_qubit_gates(circuit: cirq.Circuit) -> int

   Get number of two qubit gates in a circuit.

   :param circuit: A Cirq circuit.

   Results:
       Number of two qubit gates.


.. py:function:: total_global_rgate_pi_time(circuit: cirq.Circuit) -> float

   Get sum of rotation exponents applied by global parallel `RGate` gates in a circuit.

   :param circuit: A Cirq circuit.

   :returns: Float with value being the sum of rotation exponents.