LogicalQ.Benchmarks
===================

.. py:module:: LogicalQ.Benchmarks


Functions
---------

.. autoapisummary::

   LogicalQ.Benchmarks.mirror_benchmarking
   LogicalQ.Benchmarks.randomized_benchmarking
   LogicalQ.Benchmarks.quantum_volume
   LogicalQ.Benchmarks.quantum_teleportation
   LogicalQ.Benchmarks.n_qubit_ghz_generation


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

.. py:function:: mirror_benchmarking(n_qubits = None, qubits = None, circuit_length = 2, gate_sample = None, measure = False, seed = None)

   Constructs circuits composed of various gates and composes the full inverse as a circuit, such that the composite operation is the identity if no errors occur.

   :param n_qubits: The number of qubits in the circuit.
   :param qubits: A list of qubit indices in the circuit (default: ``list(range(n_qubits))``).
   :param circuit_length: The desired total number of layers in the circuit.
   :param gate_sample: An optional gate class, list of gate names, or list of Gates to sample from (default: Clifford gates).
   :param measure: An optional bool to specify whether to append measurements at the end of the circuit (default: ``True``).
   :param seed: An optional seed used during random choices (default: ``None``).


.. py:function:: randomized_benchmarking(n_qubits = None, qubits = None, circuit_length = 2, gate_sample = None, measure = False, seed = None)

   Constructs circuits composed of various gates and the full inverse as a single gate, such that the composite operation is the identity if no errors occur.

   :param n_qubits: The number of qubits in the circuit.
   :param qubits: An optional list of qubit indices in the circuit (default: ``list(range(n_qubits))``).
   :param circuit_length: The desired total number of layers in the circuit.
   :param gate_sample: An optional gate class, list of gate names, or list of Gates to sample from (default: Clifford gates).
   :param measure: An optional bool to specify whether to append measurements at the end of the circuit (default: ``True``).
   :param seed: An optional seed used during random choices (default: ``None``).


.. py:function:: quantum_volume(n_qubits=1, seed=None)

   Generate quantum volume benchmark circuits.

   :param n_qubits: Number of qubits available for the benchmark (sets a maximum iteration limit on the circuit width).
   :param seed: Random seed for reproducibility (default: ``None``).


.. py:function:: quantum_teleportation(statevector, barriers=False)

   Generate a quantum teleportation circuit.

   :param statevector: An arbitrary input state.
   :param barriers: A bool specifying whether to append barriers between sections of the circuit (default: ``False``).


.. py:function:: n_qubit_ghz_generation(n_qubits=3, barriers=False)

   Generate an n-qubit GHZ state generation circuit.

   :param n_qubits: Number of qubits in the GHZ state.
   :param barriers: A bool specifying whether to append barriers between sections of the circuit (default: ``False``).