supermarq.features
==================

.. py:module:: supermarq.features


Functions
---------

.. autoapisummary::

   supermarq.features.compute_communication
   supermarq.features.compute_depth
   supermarq.features.compute_entanglement
   supermarq.features.compute_liveness
   supermarq.features.compute_measurement
   supermarq.features.compute_parallelism


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

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

   Compute the *communication* feature of the input circuit.

   This function acts a wrapper which first converts the input `cirq.Circuit`
   into a `qiskit.QuantumCircuit` before calculating the feature value.

   :param circuit: A quantum circuit.

   :returns: The value of the communication feature for this circuit.


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

   Compute the *depth* feature of the input circuit.

   This function acts a wrapper which first converts the input `cirq.Circuit`
   into a `qiskit.QuantumCircuit` before calculating the feature value.

   :param circuit: A quantum circuit.

   :returns: The value of the depth feature for this circuit.


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

   Compute the *entanglement* feature of the input circuit.

   This function acts a wrapper which first converts the input `cirq.Circuit`
   into a `qiskit.QuantumCircuit` before calculating the feature value.

   :param circuit: A quantum circuit.

   :returns: The value of the entanglement feature for this circuit.


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

   Compute the *liveness* feature of the input circuit.

   This function acts a wrapper which first converts the input `cirq.Circuit`
   into a `qiskit.QuantumCircuit` before calculating the feature value.

   :param circuit: A quantum circuit.

   :returns: The value of the liveness feature for this circuit.


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

   Compute the *measurement* feature of the input circuit.

   This function acts a wrapper which first converts the input `cirq.Circuit`
   into a `qiskit.QuantumCircuit` before calculating the feature value.

   :param circuit: A quantum circuit.

   :returns: The value of the measurement feature for this circuit.


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

   Compute the *parallelism* feature of the input circuit.

   This function acts a wrapper which first converts the input `cirq.Circuit`
   into a `qiskit.QuantumCircuit` before calculating the feature value.

   :param circuit: A quantum circuit.

   :returns: The value of the parallelism feature for this circuit.