supermarq.benchmarks.hamiltonian_simulation
===========================================

.. py:module:: supermarq.benchmarks.hamiltonian_simulation


Classes
-------

.. autoapisummary::

   supermarq.benchmarks.hamiltonian_simulation.HamiltonianSimulation


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

.. py:class:: HamiltonianSimulation(num_qubits: int, time_step: int = 1, total_time: int = 1)

   Bases: :py:obj:`supermarq.benchmark.Benchmark`


   Quantum benchmark focused on the ability to simulate 1D
   Transverse Field Ising Models (TFIM) of variable length.

   Device performance is based on how closely the experimentally obtained
   average magnetization (along the Z-axis) matches the noiseless value.
   Since the 1D TFIM is efficiently simulatable with classical algorithms,
   computing the noiseless average magnetization remains scalable over a large
   range of benchmark sizes.


   .. py:method:: circuit() -> cirq.Circuit

      Generates a circuit to simulate the evolution of an n-qubit TFIM
      chain under the Hamiltonian:

      H(t) = - Jz * sum_{i=1}^{n-1}(sigma_{z}^{i} * sigma_{z}^{i+1})
             - e_ph * cos(w_ph * t) * sum_{i=1}^{n}(sigma_{x}^{i})

      where,
          w_ph: frequency of E" phonon in MoSe2.
          e_ph: strength of electron-phonon coupling.

      :returns: The circuit for Hamiltonian simulation.



   .. py:method:: qiskit_circuit() -> qiskit.QuantumCircuit

      Generates a circuit to simulate the evolution of an n-qubit TFIM
      chain under the Hamiltonian:

      H(t) = - Jz * sum_{i=1}^{n-1}(sigma_{z}^{i} * sigma_{z}^{i+1})
             - e_ph * cos(w_ph * t) * sum_{i=1}^{n}(sigma_{x}^{i})

      where,
          w_ph: frequency of E" phonon in MoSe2.
          e_ph: strength of electron-phonon coupling.

      :returns: The circuit for Hamiltonian simulation.



   .. py:method:: score(counts: collections.abc.Mapping[str, float]) -> float

      Compute the average magnetization of the TFIM chain along the Z-axis
      for the experimental results and via noiseless simulation.

      :param counts: Dictionary of the experimental results. The keys are bitstrings
                     represented the measured qubit state, and the values are the number
                     of times that state of observed.

      :returns: The Hamiltonian simulation benchmark score.



   .. py:attribute:: num_qubits


   .. py:attribute:: time_step
      :value: 1



   .. py:attribute:: total_time
      :value: 1