qiskit.algorithms.Eigensolver

class Eigensolver

The Eigensolver Interface.

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

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()	Initialize self.
compute_eigenvalues(operator[, aux_operators])	Computes eigenvalues.
supports_aux_operators()	Whether computing the expectation value of auxiliary operators is supported.

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 (Optional[List[Optional[OperatorBase]]]) – 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.

Return type

EigensolverResult

Returns

EigensolverResult

classmethod supports_aux_operators()

Whether computing the expectation value of auxiliary operators is supported.

Return type

bool

Returns

True if aux_operator expectations can be evaluated, False otherwise