80 lines
3.5 KiB
Plaintext
80 lines
3.5 KiB
Plaintext
---
|
||
title: MinimumEigensolverResult
|
||
description: API reference for qiskit.algorithms.MinimumEigensolverResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.MinimumEigensolverResult
|
||
---
|
||
|
||
# qiskit.algorithms.MinimumEigensolverResult
|
||
|
||
<Class id="qiskit.algorithms.MinimumEigensolverResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py" signature="MinimumEigensolverResult" modifiers="class">
|
||
Minimum Eigensolver Result.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.algorithms.MinimumEigensolverResult.__init__" signature="__init__()">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.algorithms.MinimumEigensolverResult.__init__ "qiskit.algorithms.MinimumEigensolverResult.__init__")() | Initialize self. |
|
||
| [`combine`](#qiskit.algorithms.MinimumEigensolverResult.combine "qiskit.algorithms.MinimumEigensolverResult.combine")(result) | Any property from the argument that exists in the receiver is updated. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
|
||
| [`aux_operator_eigenvalues`](#qiskit.algorithms.MinimumEigensolverResult.aux_operator_eigenvalues "qiskit.algorithms.MinimumEigensolverResult.aux_operator_eigenvalues") | return aux operator eigen values |
|
||
| [`eigenstate`](#qiskit.algorithms.MinimumEigensolverResult.eigenstate "qiskit.algorithms.MinimumEigensolverResult.eigenstate") | return eigen state |
|
||
| [`eigenvalue`](#qiskit.algorithms.MinimumEigensolverResult.eigenvalue "qiskit.algorithms.MinimumEigensolverResult.eigenvalue") | returns eigen value |
|
||
|
||
### aux\_operator\_eigenvalues
|
||
|
||
<Attribute id="qiskit.algorithms.MinimumEigensolverResult.aux_operator_eigenvalues">
|
||
return aux operator eigen values
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.MinimumEigensolverResult.combine" signature="combine(result)">
|
||
Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set.
|
||
|
||
**Raises**
|
||
|
||
**TypeError** – Argument is None
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
### eigenstate
|
||
|
||
<Attribute id="qiskit.algorithms.MinimumEigensolverResult.eigenstate">
|
||
return eigen state
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### eigenvalue
|
||
|
||
<Attribute id="qiskit.algorithms.MinimumEigensolverResult.eigenvalue">
|
||
returns eigen value
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`complex`]
|
||
</Attribute>
|
||
</Class>
|
||
|