MinimumEigensolver#
- class MinimumEigensolver[source]#
Bases:
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
- abstract compute_minimum_eigenvalue(operator, aux_operators=None)[source]#
Computes the minimum eigenvalue. The
operator
andaux_operators
are supplied here. While anoperator
is required by algorithms,aux_operators
are optional.- Parameters:
operator (BaseOperator) – Qubit operator of the observable.
aux_operators (ListOrDict[BaseOperator] | 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.
- Returns:
A minimum eigensolver result.
- Return type:
- classmethod supports_aux_operators()[source]#
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 theaux_operators
for that state. Otherwise they will be ignored.- Returns:
True if aux_operator expectations can be evaluated, False otherwise
- Return type: