Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

Eigensolver

class qiskit.algorithms.Eigensolver

GitHub

Bases: ABC

Deprecated: Eigensolver Interface.

The Eigensolver interface has been superseded by the qiskit.algorithms.eigensolvers.Eigensolver interface. This interface will be deprecated in a future release and subsequently removed after that.

Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably.

Deprecated since version 0.24.0

The class qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver is deprecated as of qiskit 0.24.0. It will be removed no earlier than 3 months after the release date. Instead, use the interface qiskit.algorithms.eigensolvers.Eigensolver. See https://qisk.it/algo_migration for a migration guide.


Methods

compute_eigenvalues

abstract compute_eigenvalues(operator, aux_operators=None)

Computes eigenvalues. Operator and aux_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux_operators are optional. To ‘remove’ a previous aux_operators array use an empty list here.

Parameters

  • operator (OperatorBase) – Qubit operator of the Observable
  • aux_operators (ListOrDict[OperatorBase] | None) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state.

Returns

EigensolverResult

Return type

EigensolverResult

supports_aux_operators

classmethod supports_aux_operators()

Whether computing the expectation value of auxiliary operators is supported.

Returns

True if aux_operator expectations can be evaluated, False otherwise

Return type

bool

Was this page helpful?
Report a bug or request content on GitHub.