56 lines
2.6 KiB
Plaintext
56 lines
2.6 KiB
Plaintext
---
|
||
title: Eigensolver
|
||
description: API reference for qiskit.algorithms.eigensolvers.Eigensolver
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.eigensolvers.Eigensolver
|
||
---
|
||
|
||
# Eigensolver
|
||
|
||
<Class id="qiskit.algorithms.eigensolvers.Eigensolver" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigensolvers/eigensolver.py" signature="qiskit.algorithms.eigensolvers.Eigensolver" modifiers="class">
|
||
Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)")
|
||
|
||
The eigensolver interface.
|
||
|
||
Algorithms that can compute eigenvalues for an operator may implement this interface to allow different algorithms to be used interchangeably.
|
||
|
||
## Methods
|
||
|
||
### compute\_eigenvalues
|
||
|
||
<Function id="qiskit.algorithms.eigensolvers.Eigensolver.compute_eigenvalues" signature="compute_eigenvalues(operator, aux_operators=None)" modifiers="abstract">
|
||
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*](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")) – Qubit operator of the observable.
|
||
* **aux\_operators** (*ListOrDict\[BaseOperator |* [*PauliSumOp*](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")*] | 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 and total particle count operators, so we can get values for these at the ground state.
|
||
|
||
**Returns**
|
||
|
||
An eigensolver result.
|
||
|
||
**Return type**
|
||
|
||
[EigensolverResult](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.EigensolverResult")
|
||
</Function>
|
||
|
||
### supports\_aux\_operators
|
||
|
||
<Function id="qiskit.algorithms.eigensolvers.Eigensolver.supports_aux_operators" signature="supports_aux_operators()" modifiers="classmethod">
|
||
Whether computing the expectation value of auxiliary operators is supported.
|
||
|
||
If the eigensolver computes the eigenvalues of the main operator, then it can compute the expectation value of the `aux_operators` for that state. Otherwise they will be ignored.
|
||
|
||
**Returns**
|
||
|
||
`True` if `aux_operator` expectations can be evaluated, `False` otherwise.
|
||
|
||
**Return type**
|
||
|
||
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")
|
||
</Function>
|
||
</Class>
|
||
|