76 lines
2.4 KiB
Plaintext
76 lines
2.4 KiB
Plaintext
---
|
||
title: Eigensolver
|
||
description: API reference for qiskit.aqua.algorithms.Eigensolver
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.algorithms.Eigensolver
|
||
---
|
||
|
||
# Eigensolver
|
||
|
||
<Class id="qiskit.aqua.algorithms.Eigensolver" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/eigen_solvers/eigen_solver.py" signature="Eigensolver" modifiers="class">
|
||
Bases: `abc.ABC`
|
||
|
||
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.aqua.algorithms.Eigensolver.compute_eigenvalues" signature="Eigensolver.compute_eigenvalues(operator=None, aux_operators=None)" modifiers="abstract">
|
||
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
|
||
</Function>
|
||
|
||
### supports\_aux\_operators
|
||
|
||
<Function id="qiskit.aqua.algorithms.Eigensolver.supports_aux_operators" signature="Eigensolver.supports_aux_operators()" modifiers="classmethod">
|
||
Whether computing the expectation value of auxiliary operators is supported.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
True if aux\_operator expectations can be evaluated, False otherwise
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### aux\_operators
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.Eigensolver.aux_operators">
|
||
Returns the auxiliary operators.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]
|
||
</Attribute>
|
||
|
||
### operator
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.Eigensolver.operator">
|
||
Return the operator.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]
|
||
</Attribute>
|
||
</Class>
|
||
|