qc2.algorithms.base.vqe_base_results
====================================

.. py:module:: qc2.algorithms.base.vqe_base_results

.. autoapi-nested-parse::

   This module defines the base class for VQE algorithms results.



Classes
-------

.. autoapisummary::

   qc2.algorithms.base.vqe_base_results.VQEBASEResults


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

.. py:class:: VQEBASEResults

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


   VQE result base class.


   .. py:attribute:: _optimizer_evals
      :type:  Optional[int]
      :value: None



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



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



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



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



   .. py:attribute:: _metadata
      :type:  Optional[Dict]
      :value: None



   .. py:property:: optimizer_evals
      :type: Optional[int]


      Returns number of optimizer evaluations.


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


      Returns optimal parameters.


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


      Returns optimal energy.


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


      Returns list of energies of all iterations.


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


      Returns list with parameters of all iteration.


   .. py:property:: metadata
      :type: Optional[Dict]


      Returns dict with metadata of all iterations.