qiskit.aqua.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__
abstract __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. |
Attributes
aux_operators | Returns the auxiliary operators. |
operator | Return the operator. |
aux_operators
abstract property aux_operators
Returns the auxiliary operators.
Return type
Optional[List[Optional[OperatorBase]]]
compute_eigenvalues
abstract compute_eigenvalues(operator=None, 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 (
Union[OperatorBase,LegacyBaseOperator,None]) – If not None replaces operator in algorithm - aux_operators (
Optional[List[Union[OperatorBase,LegacyBaseOperator,None]]]) – If not None replaces aux_operators in algorithm
Return type
EigensolverResult
Returns
EigensolverResult
operator
abstract property operator
Return the operator.
Return type
Union[OperatorBase, LegacyBaseOperator, None]
supports_aux_operators
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