167 lines
5.2 KiB
Plaintext
167 lines
5.2 KiB
Plaintext
---
|
||
title: MinimumEigensolverResult (v0.31)
|
||
description: API reference for qiskit.aqua.algorithms.MinimumEigensolverResult in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult
|
||
---
|
||
|
||
# MinimumEigensolverResult
|
||
|
||
<Class id="qiskit.aqua.algorithms.MinimumEigensolverResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py" signature="MinimumEigensolverResult(a_dict=None)" modifiers="class">
|
||
Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult`
|
||
|
||
Minimum Eigensolver Result.
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-clear" />
|
||
|
||
### clear
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.clear" signature="MinimumEigensolverResult.clear()">
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-combine" />
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.combine" signature="MinimumEigensolverResult.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>
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-copy" />
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.copy" signature="MinimumEigensolverResult.copy()" />
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-from-dict" />
|
||
|
||
### from\_dict
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.from_dict" signature="MinimumEigensolverResult.from_dict(a_dict)" modifiers="static">
|
||
create new object from a dictionary
|
||
|
||
**Return type**
|
||
|
||
`MinimumEigensolverResult`
|
||
</Function>
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-fromkeys" />
|
||
|
||
### fromkeys
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.fromkeys" signature="MinimumEigensolverResult.fromkeys(iterable, value=None)" modifiers="classmethod" />
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-get" />
|
||
|
||
### get
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.get" signature="MinimumEigensolverResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None." />
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-items" />
|
||
|
||
### items
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.items" signature="MinimumEigensolverResult.items() → a set-like object providing a view on D’s items" />
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-keys" />
|
||
|
||
### keys
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.keys" signature="MinimumEigensolverResult.keys() → a set-like object providing a view on D’s keys" />
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-pop" />
|
||
|
||
### pop
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.pop" signature="MinimumEigensolverResult.pop(key, default=None)">
|
||
If key is not found, d is returned if given, otherwise KeyError is raised.
|
||
|
||
**Return type**
|
||
|
||
`object`
|
||
</Function>
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-popitem" />
|
||
|
||
### popitem
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.popitem" signature="MinimumEigensolverResult.popitem()">
|
||
as a 2-tuple; but raise KeyError if D is empty.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`object`, `object`]
|
||
</Function>
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-setdefault" />
|
||
|
||
### setdefault
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.setdefault" signature="MinimumEigensolverResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-update" />
|
||
|
||
### update
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.update" signature="MinimumEigensolverResult.update(*args, **kwargs)">
|
||
If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
<span id="qiskit-aqua-algorithms-minimumeigensolverresult-values" />
|
||
|
||
### values
|
||
|
||
<Function id="qiskit.aqua.algorithms.MinimumEigensolverResult.values" signature="MinimumEigensolverResult.values() → an object providing a view on D’s values" />
|
||
|
||
## Attributes
|
||
|
||
### aux\_operator\_eigenvalues
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.MinimumEigensolverResult.aux_operator_eigenvalues">
|
||
return aux operator eigen values
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### eigenstate
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.MinimumEigensolverResult.eigenstate">
|
||
return eigen state
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### eigenvalue
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.MinimumEigensolverResult.eigenvalue">
|
||
returns eigen value
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`complex`]
|
||
</Attribute>
|
||
</Class>
|
||
|