161 lines
4.5 KiB
Plaintext
161 lines
4.5 KiB
Plaintext
---
|
||
title: EigenstateResult
|
||
description: API reference for qiskit.chemistry.results.EigenstateResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.chemistry.results.EigenstateResult
|
||
---
|
||
|
||
# EigenstateResult
|
||
|
||
<Class id="qiskit.chemistry.results.EigenstateResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/eigenstate_result.py" signature="EigenstateResult(a_dict=None)" modifiers="class">
|
||
Bases: `qiskit.aqua.algorithms.algorithm_result.AlgorithmResult`
|
||
|
||
The eigenstate result interface.
|
||
|
||
## Methods
|
||
|
||
### clear
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.clear" signature="EigenstateResult.clear()">
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.combine" signature="EigenstateResult.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>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.copy" signature="EigenstateResult.copy()" />
|
||
|
||
### fromkeys
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.fromkeys" signature="EigenstateResult.fromkeys(iterable, value=None)" modifiers="classmethod" />
|
||
|
||
### get
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.get" signature="EigenstateResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None." />
|
||
|
||
### items
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.items" signature="EigenstateResult.items() → a set-like object providing a view on D’s items" />
|
||
|
||
### keys
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.keys" signature="EigenstateResult.keys() → a set-like object providing a view on D’s keys" />
|
||
|
||
### pop
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.pop" signature="EigenstateResult.pop(key, default=None)">
|
||
If key is not found, d is returned if given, otherwise KeyError is raised.
|
||
|
||
**Return type**
|
||
|
||
`object`
|
||
</Function>
|
||
|
||
### popitem
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.popitem" signature="EigenstateResult.popitem()">
|
||
as a 2-tuple; but raise KeyError if D is empty.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`object`, `object`]
|
||
</Function>
|
||
|
||
### setdefault
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.setdefault" signature="EigenstateResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />
|
||
|
||
### update
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.update" signature="EigenstateResult.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>
|
||
|
||
### values
|
||
|
||
<Function id="qiskit.chemistry.results.EigenstateResult.values" signature="EigenstateResult.values() → an object providing a view on D’s values" />
|
||
|
||
## Attributes
|
||
|
||
### aux\_operator\_eigenvalues
|
||
|
||
<Attribute id="qiskit.chemistry.results.EigenstateResult.aux_operator_eigenvalues">
|
||
return aux operator eigen values
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`float`]]
|
||
</Attribute>
|
||
|
||
### eigenenergies
|
||
|
||
<Attribute id="qiskit.chemistry.results.EigenstateResult.eigenenergies">
|
||
returns eigen energies
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### eigenstates
|
||
|
||
<Attribute id="qiskit.chemistry.results.EigenstateResult.eigenstates">
|
||
returns eigen states
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]]
|
||
</Attribute>
|
||
|
||
### groundenergy
|
||
|
||
<Attribute id="qiskit.chemistry.results.EigenstateResult.groundenergy">
|
||
returns ground energy
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`float`]
|
||
</Attribute>
|
||
|
||
### groundstate
|
||
|
||
<Attribute id="qiskit.chemistry.results.EigenstateResult.groundstate">
|
||
returns ground state
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`]
|
||
</Attribute>
|
||
|
||
### raw\_result
|
||
|
||
<Attribute id="qiskit.chemistry.results.EigenstateResult.raw_result">
|
||
Returns the raw algorithm result.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`AlgorithmResult`]
|
||
</Attribute>
|
||
</Class>
|
||
|