qiskit-documentation/docs/api/qiskit/0.44/qiskit.algorithms.Eigensolv...

57 lines
2.2 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: EigensolverResult
description: API reference for qiskit.algorithms.EigensolverResult
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.algorithms.EigensolverResult
---
# EigensolverResult
<Class id="qiskit.algorithms.EigensolverResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/eigen_solvers/eigen_solver.py" signature="qiskit.algorithms.EigensolverResult" modifiers="class">
Bases: `AlgorithmResult`
Deprecated: Eigensolver Result.
The EigensolverResult class has been superseded by the [`qiskit.algorithms.eigensolvers.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.EigensolverResult") class. This class will be deprecated in a future release and subsequently removed after that.
<Admonition title="Deprecated since version 0.24.0" type="danger">
The class `qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult` is deprecated as of qiskit-terra 0.24.0. It will be removed no earlier than 3 months after the release date. Instead, use the class `qiskit.algorithms.eigensolvers.EigensolverResult`. See [https://qisk.it/algo\_migration](https://qisk.it/algo_migration) for a migration guide.
</Admonition>
## Attributes
### aux\_operator\_eigenvalues
<Attribute id="qiskit.algorithms.EigensolverResult.aux_operator_eigenvalues">
Return aux operator expectation values.
These values are in fact tuples formatted as (mean, standard deviation).
</Attribute>
### eigenstates
<Attribute id="qiskit.algorithms.EigensolverResult.eigenstates">
return eigen states
</Attribute>
### eigenvalues
<Attribute id="qiskit.algorithms.EigensolverResult.eigenvalues">
returns eigen values
</Attribute>
## Methods
### combine
<Function id="qiskit.algorithms.EigensolverResult.combine" signature="combine(result)">
Any property from the argument that exists in the receiver is updated. :param result: Argument result with properties to be set.
**Raises**
[**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.12)") Argument is None
</Function>
</Class>