qc2.algorithms.algorithms_results
=================================

.. py:module:: qc2.algorithms.algorithms_results

.. autoapi-nested-parse::

   This modules contains child classes to build algorithm results.



Classes
-------

.. autoapisummary::

   qc2.algorithms.algorithms_results.QPEResults
   qc2.algorithms.algorithms_results.VQEResults
   qc2.algorithms.algorithms_results.OOVQEResults


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

.. py:class:: QPEResults

   Bases: :py:obj:`qc2.algorithms.base.base_algorithm_results.BaseAlgorithmResults`


   Extends VQEBASEResults to provide specialized data container for QPE.


   .. py:attribute:: _phase
      :type:  Optional[float]
      :value: None



   .. py:attribute:: _eigenvalue
      :type:  Optional[float]
      :value: None



   .. py:attribute:: _optimal_energy
      :type:  Optional[float]
      :value: None



   .. py:property:: phase
      :type: float


      Returns the phase.


   .. py:property:: eigenvalue
      :type: float


      Returns the eigenvalue.


   .. py:property:: optimal_energy
      :type: Optional[float]


      Returns optimal energy.


.. py:class:: VQEResults

   Bases: :py:obj:`qc2.algorithms.base.vqe_base_results.VQEBASEResults`


   Extends VQEBASEResults to provide specialized data container for VQE.


.. py:class:: OOVQEResults

   Bases: :py:obj:`VQEResults`


   Extends VQEResults to provide a results data container for oo-VQE.


   .. py:attribute:: _optimal_circuit_params
      :type:  Optional[List]
      :value: None



   .. py:attribute:: _optimal_orbital_params
      :type:  Optional[List]
      :value: None



   .. py:attribute:: _circuit_parameters
      :type:  Optional[List]
      :value: None



   .. py:attribute:: _orbital_parameters
      :type:  Optional[List]
      :value: None



   .. py:property:: optimal_circuit_params
      :type: Optional[List]


      Returns the optimal circuit parameters.


   .. py:property:: optimal_orbital_params
      :type: Optional[List]


      Returns optimal orbital parameters.


   .. py:property:: circuit_parameters
      :type: Optional[List]


      Returns list with circuit parameters of all iteration.


   .. py:property:: orbital_parameters
      :type: Optional[List]


      Returns list with orbital parameters of all iteration.