226 lines
14 KiB
Plaintext
226 lines
14 KiB
Plaintext
---
|
||
title: VibronicStructureResult
|
||
description: API reference for qiskit.chemistry.results.VibronicStructureResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.chemistry.results.VibronicStructureResult
|
||
---
|
||
|
||
# qiskit.chemistry.results.VibronicStructureResult
|
||
|
||
<Class id="qiskit.chemistry.results.VibronicStructureResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py" signature="VibronicStructureResult(a_dict=None)" modifiers="class">
|
||
The vibronic structure result.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.__init__" signature="__init__(a_dict=None)">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.chemistry.results.VibronicStructureResult.__init__ "qiskit.chemistry.results.VibronicStructureResult.__init__")(\[a\_dict]) | Initialize self. |
|
||
| [`clear`](#qiskit.chemistry.results.VibronicStructureResult.clear "qiskit.chemistry.results.VibronicStructureResult.clear")() | **rtype**`None` |
|
||
| [`combine`](#qiskit.chemistry.results.VibronicStructureResult.combine "qiskit.chemistry.results.VibronicStructureResult.combine")(result) | Any property from the argument that exists in the receiver is updated. |
|
||
| `copy`() | |
|
||
| `fromkeys`(iterable\[, value]) | |
|
||
| [`get`](#qiskit.chemistry.results.VibronicStructureResult.get "qiskit.chemistry.results.VibronicStructureResult.get")(k\[,d]) | |
|
||
| [`items`](#qiskit.chemistry.results.VibronicStructureResult.items "qiskit.chemistry.results.VibronicStructureResult.items")() | |
|
||
| [`keys`](#qiskit.chemistry.results.VibronicStructureResult.keys "qiskit.chemistry.results.VibronicStructureResult.keys")() | |
|
||
| [`pop`](#qiskit.chemistry.results.VibronicStructureResult.pop "qiskit.chemistry.results.VibronicStructureResult.pop")(key\[, default]) | If key is not found, d is returned if given, otherwise KeyError is raised. |
|
||
| [`popitem`](#qiskit.chemistry.results.VibronicStructureResult.popitem "qiskit.chemistry.results.VibronicStructureResult.popitem")() | as a 2-tuple; but raise KeyError if D is empty. |
|
||
| [`setdefault`](#qiskit.chemistry.results.VibronicStructureResult.setdefault "qiskit.chemistry.results.VibronicStructureResult.setdefault")(k\[,d]) | |
|
||
| [`update`](#qiskit.chemistry.results.VibronicStructureResult.update "qiskit.chemistry.results.VibronicStructureResult.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 |
|
||
| [`values`](#qiskit.chemistry.results.VibronicStructureResult.values "qiskit.chemistry.results.VibronicStructureResult.values")() | |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||
| [`algorithm_result`](#qiskit.chemistry.results.VibronicStructureResult.algorithm_result "qiskit.chemistry.results.VibronicStructureResult.algorithm_result") | Returns raw algorithm result |
|
||
| [`aux_operator_eigenvalues`](#qiskit.chemistry.results.VibronicStructureResult.aux_operator_eigenvalues "qiskit.chemistry.results.VibronicStructureResult.aux_operator_eigenvalues") | return aux operator eigen values |
|
||
| [`computed_vibronic_energies`](#qiskit.chemistry.results.VibronicStructureResult.computed_vibronic_energies "qiskit.chemistry.results.VibronicStructureResult.computed_vibronic_energies") | Returns computed electronic part of ground state energy |
|
||
| [`eigenenergies`](#qiskit.chemistry.results.VibronicStructureResult.eigenenergies "qiskit.chemistry.results.VibronicStructureResult.eigenenergies") | returns eigen energies |
|
||
| [`eigenstates`](#qiskit.chemistry.results.VibronicStructureResult.eigenstates "qiskit.chemistry.results.VibronicStructureResult.eigenstates") | returns eigen states |
|
||
| [`formatted`](#qiskit.chemistry.results.VibronicStructureResult.formatted "qiskit.chemistry.results.VibronicStructureResult.formatted") | Formatted result as a list of strings |
|
||
| [`groundenergy`](#qiskit.chemistry.results.VibronicStructureResult.groundenergy "qiskit.chemistry.results.VibronicStructureResult.groundenergy") | returns ground energy |
|
||
| [`groundstate`](#qiskit.chemistry.results.VibronicStructureResult.groundstate "qiskit.chemistry.results.VibronicStructureResult.groundstate") | returns ground state |
|
||
| [`num_occupied_modals_per_mode`](#qiskit.chemistry.results.VibronicStructureResult.num_occupied_modals_per_mode "qiskit.chemistry.results.VibronicStructureResult.num_occupied_modals_per_mode") | Returns the number of occupied modal per mode |
|
||
| [`raw_result`](#qiskit.chemistry.results.VibronicStructureResult.raw_result "qiskit.chemistry.results.VibronicStructureResult.raw_result") | Returns the raw algorithm result. |
|
||
|
||
### algorithm\_result
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.algorithm_result">
|
||
Returns raw algorithm result
|
||
|
||
**Return type**
|
||
|
||
`AlgorithmResult`
|
||
</Attribute>
|
||
|
||
### aux\_operator\_eigenvalues
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.aux_operator_eigenvalues">
|
||
return aux operator eigen values
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`float`]]
|
||
</Attribute>
|
||
|
||
### clear
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.clear" signature="clear()">
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.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>
|
||
|
||
### computed\_vibronic\_energies
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.computed_vibronic_energies">
|
||
Returns computed electronic part of ground state energy
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
</Attribute>
|
||
|
||
### eigenenergies
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.eigenenergies">
|
||
returns eigen energies
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### eigenstates
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.eigenstates">
|
||
returns eigen states
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]]
|
||
</Attribute>
|
||
|
||
### formatted
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.formatted">
|
||
Formatted result as a list of strings
|
||
|
||
**Return type**
|
||
|
||
`List`\[`str`]
|
||
</Attribute>
|
||
|
||
### get
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.get" signature="get(k[, d]) → D[k] if k in D, else d. d defaults to None." />
|
||
|
||
### groundenergy
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.groundenergy">
|
||
returns ground energy
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`float`]
|
||
</Attribute>
|
||
|
||
### groundstate
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.groundstate">
|
||
returns ground state
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`]
|
||
</Attribute>
|
||
|
||
### items
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.items" signature="items() → a set-like object providing a view on D’s items" />
|
||
|
||
### keys
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.keys" signature="keys() → a set-like object providing a view on D’s keys" />
|
||
|
||
### num\_occupied\_modals\_per\_mode
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.num_occupied_modals_per_mode">
|
||
Returns the number of occupied modal per mode
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`float`]]
|
||
</Attribute>
|
||
|
||
### pop
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.pop" signature="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.VibronicStructureResult.popitem" signature="popitem()">
|
||
as a 2-tuple; but raise KeyError if D is empty.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`object`, `object`]
|
||
</Function>
|
||
|
||
### raw\_result
|
||
|
||
<Attribute id="qiskit.chemistry.results.VibronicStructureResult.raw_result">
|
||
Returns the raw algorithm result.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`AlgorithmResult`]
|
||
</Attribute>
|
||
|
||
### setdefault
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.setdefault" signature="setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />
|
||
|
||
### update
|
||
|
||
<Function id="qiskit.chemistry.results.VibronicStructureResult.update" signature="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.VibronicStructureResult.values" signature="values() → an object providing a view on D’s values" />
|
||
</Class>
|
||
|