MinimumEigensolver
class MinimumEigensolver
Bases: abc.ABC
The minimum eigensolver interface.
Algorithms that can compute a minimum eigenvalue for an operator may implement this interface to allow different algorithms to be used interchangeably.
Methods
compute_minimum_eigenvalue
abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)
Computes the minimum eigenvalue. The operator and aux_operators are supplied here. While an operator is required by algorithms, aux_operators are optional.
Parameters
- operator (BaseOperator | PauliSumOp) – Qubit operator of the observable.
- aux_operators (ListOrDict[BaseOperator | PauliSumOp] | None) – Optional list of auxiliary operators to be evaluated with the parameters of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators and total particle count operators, so we can get values for these at the ground state.
Return type
Returns
A minimum eigensolver result.
supports_aux_operators
classmethod MinimumEigensolver.supports_aux_operators()
Whether computing the expectation value of auxiliary operators is supported.
If the minimum eigensolver computes an eigenvalue of the main operator then it can compute the expectation value of the aux_operators for that state. Otherwise they will be ignored.
Return type
bool
Returns
True if aux_operator expectations can be evaluated, False otherwise