supermarq.benchmark
===================

.. py:module:: supermarq.benchmark


Classes
-------

.. autoapisummary::

   supermarq.benchmark.Benchmark


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

.. py:class:: Benchmark

   Class representing a quantum benchmark application.

   Concrete subclasses must implement the abstract methods ``circuit()`` and
   ``score()``.

   Each instantiation of a `Benchmark` object represents a single, fully defined
   benchmark application. All the relevant parameters for a benchmark should
   be passed in upon creation, and will be used to generate the correct circuit
   and compute the final score.


   .. py:method:: circuit() -> cirq.Circuit | list[cirq.Circuit]
      :abstractmethod:


      Returns the quantum circuit(s) corresponding to the current benchmark parameters.



   .. py:method:: cirq_circuit() -> cirq.Circuit | list[cirq.Circuit]

      Returns:
      The cirq circuit(s) corresponding to the current benchmark parameters.



   .. py:method:: qiskit_circuit() -> qiskit.QuantumCircuit | list[qiskit.QuantumCircuit]

      Returns:
      The qiskit circuit(s) corresponding to the current benchmark parameters.



   .. py:method:: score(counts: Any) -> float
      :abstractmethod:


      Returns a normalized [0,1] score reflecting device performance.

      :param counts: Dictionary(s) containing the measurement counts from execution.