scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit/0.24/qiskit.chemistry.results.El...

444 lines
25 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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: ElectronicStructureResult
description: API reference for qiskit.chemistry.results.ElectronicStructureResult
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.chemistry.results.ElectronicStructureResult
---
<span id="qiskit-chemistry-results-electronicstructureresult" />
# qiskit.chemistry.results.ElectronicStructureResult
<Class id="qiskit.chemistry.results.ElectronicStructureResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/chemistry/results/electronic_structure_result.py" signature="ElectronicStructureResult(a_dict=None)" modifiers="class">
The electronic structure result.
### \_\_init\_\_
<Function id="qiskit.chemistry.results.ElectronicStructureResult.__init__" signature="__init__(a_dict=None)">
Initialize self. See help(type(self)) for accurate signature.
</Function>
## Methods
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`__init__`](#qiskit.chemistry.results.ElectronicStructureResult.__init__ "qiskit.chemistry.results.ElectronicStructureResult.__init__")(\[a\_dict]) | Initialize self. |
| [`clear`](#qiskit.chemistry.results.ElectronicStructureResult.clear "qiskit.chemistry.results.ElectronicStructureResult.clear")() | **rtype**`None` |
| [`combine`](#qiskit.chemistry.results.ElectronicStructureResult.combine "qiskit.chemistry.results.ElectronicStructureResult.combine")(result) | Any property from the argument that exists in the receiver is updated. |
| `copy`() | |
| `fromkeys`(iterable\[, value]) | |
| [`get`](#qiskit.chemistry.results.ElectronicStructureResult.get "qiskit.chemistry.results.ElectronicStructureResult.get")(k\[,d]) | |
| [`has_dipole`](#qiskit.chemistry.results.ElectronicStructureResult.has_dipole "qiskit.chemistry.results.ElectronicStructureResult.has_dipole")() | Returns whether dipole moment is present in result or not |
| [`has_observables`](#qiskit.chemistry.results.ElectronicStructureResult.has_observables "qiskit.chemistry.results.ElectronicStructureResult.has_observables")() | Returns whether result has aux op observables such as spin, num particles |
| [`items`](#qiskit.chemistry.results.ElectronicStructureResult.items "qiskit.chemistry.results.ElectronicStructureResult.items")() | |
| [`keys`](#qiskit.chemistry.results.ElectronicStructureResult.keys "qiskit.chemistry.results.ElectronicStructureResult.keys")() | |
| [`pop`](#qiskit.chemistry.results.ElectronicStructureResult.pop "qiskit.chemistry.results.ElectronicStructureResult.pop")(key\[, default]) | If key is not found, d is returned if given, otherwise KeyError is raised. |
| [`popitem`](#qiskit.chemistry.results.ElectronicStructureResult.popitem "qiskit.chemistry.results.ElectronicStructureResult.popitem")() | as a 2-tuple; but raise KeyError if D is empty. |
| [`setdefault`](#qiskit.chemistry.results.ElectronicStructureResult.setdefault "qiskit.chemistry.results.ElectronicStructureResult.setdefault")(k\[,d]) | |
| [`update`](#qiskit.chemistry.results.ElectronicStructureResult.update "qiskit.chemistry.results.ElectronicStructureResult.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.ElectronicStructureResult.values "qiskit.chemistry.results.ElectronicStructureResult.values")() | |
## Attributes
| | |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [`aux_operator_eigenvalues`](#qiskit.chemistry.results.ElectronicStructureResult.aux_operator_eigenvalues "qiskit.chemistry.results.ElectronicStructureResult.aux_operator_eigenvalues") | return aux operator eigen values |
| [`computed_dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.computed_dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.computed_dipole_moment") | Returns computed electronic part of dipole moment |
| [`computed_energies`](#qiskit.chemistry.results.ElectronicStructureResult.computed_energies "qiskit.chemistry.results.ElectronicStructureResult.computed_energies") | Returns computed electronic part of ground state energy |
| [`dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.dipole_moment") | Returns dipole moment |
| [`dipole_moment_in_debye`](#qiskit.chemistry.results.ElectronicStructureResult.dipole_moment_in_debye "qiskit.chemistry.results.ElectronicStructureResult.dipole_moment_in_debye") | Returns dipole moment in Debye |
| [`eigenenergies`](#qiskit.chemistry.results.ElectronicStructureResult.eigenenergies "qiskit.chemistry.results.ElectronicStructureResult.eigenenergies") | returns eigen energies |
| [`eigenstates`](#qiskit.chemistry.results.ElectronicStructureResult.eigenstates "qiskit.chemistry.results.ElectronicStructureResult.eigenstates") | returns eigen states |
| [`electronic_dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.electronic_dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.electronic_dipole_moment") | Returns electronic dipole moment |
| [`electronic_energies`](#qiskit.chemistry.results.ElectronicStructureResult.electronic_energies "qiskit.chemistry.results.ElectronicStructureResult.electronic_energies") | Returns electronic part of ground state energy |
| [`formatted`](#qiskit.chemistry.results.ElectronicStructureResult.formatted "qiskit.chemistry.results.ElectronicStructureResult.formatted") | Formatted result as a list of strings |
| [`frozen_extracted_dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.frozen_extracted_dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.frozen_extracted_dipole_moment") | Returns frozen extracted part of dipole moment |
| [`frozen_extracted_energy`](#qiskit.chemistry.results.ElectronicStructureResult.frozen_extracted_energy "qiskit.chemistry.results.ElectronicStructureResult.frozen_extracted_energy") | Returns frozen extracted part of ground state energy |
| [`groundenergy`](#qiskit.chemistry.results.ElectronicStructureResult.groundenergy "qiskit.chemistry.results.ElectronicStructureResult.groundenergy") | returns ground energy |
| [`groundstate`](#qiskit.chemistry.results.ElectronicStructureResult.groundstate "qiskit.chemistry.results.ElectronicStructureResult.groundstate") | returns ground state |
| [`hartree_fock_energy`](#qiskit.chemistry.results.ElectronicStructureResult.hartree_fock_energy "qiskit.chemistry.results.ElectronicStructureResult.hartree_fock_energy") | Returns Hartree-Fock energy |
| [`magnetization`](#qiskit.chemistry.results.ElectronicStructureResult.magnetization "qiskit.chemistry.results.ElectronicStructureResult.magnetization") | Returns measured magnetization |
| [`nuclear_dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.nuclear_dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.nuclear_dipole_moment") | Returns nuclear dipole moment X,Y,Z components in A.U when available from driver |
| [`nuclear_repulsion_energy`](#qiskit.chemistry.results.ElectronicStructureResult.nuclear_repulsion_energy "qiskit.chemistry.results.ElectronicStructureResult.nuclear_repulsion_energy") | Returns nuclear repulsion energy when available from driver |
| [`num_particles`](#qiskit.chemistry.results.ElectronicStructureResult.num_particles "qiskit.chemistry.results.ElectronicStructureResult.num_particles") | Returns measured number of particles |
| [`ph_extracted_dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.ph_extracted_dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.ph_extracted_dipole_moment") | Returns particle hole extracted part of dipole moment |
| [`ph_extracted_energy`](#qiskit.chemistry.results.ElectronicStructureResult.ph_extracted_energy "qiskit.chemistry.results.ElectronicStructureResult.ph_extracted_energy") | Returns particle hole extracted part of ground state energy |
| [`raw_result`](#qiskit.chemistry.results.ElectronicStructureResult.raw_result "qiskit.chemistry.results.ElectronicStructureResult.raw_result") | Returns the raw algorithm result. |
| [`reverse_dipole_sign`](#qiskit.chemistry.results.ElectronicStructureResult.reverse_dipole_sign "qiskit.chemistry.results.ElectronicStructureResult.reverse_dipole_sign") | Returns if electronic dipole moment sign should be reversed when adding to nuclear |
| [`spin`](#qiskit.chemistry.results.ElectronicStructureResult.spin "qiskit.chemistry.results.ElectronicStructureResult.spin") | Returns computed spin |
| [`total_angular_momentum`](#qiskit.chemistry.results.ElectronicStructureResult.total_angular_momentum "qiskit.chemistry.results.ElectronicStructureResult.total_angular_momentum") | Returns total angular momentum (S^2) |
| [`total_dipole_moment`](#qiskit.chemistry.results.ElectronicStructureResult.total_dipole_moment "qiskit.chemistry.results.ElectronicStructureResult.total_dipole_moment") | Returns total dipole of moment |
| [`total_dipole_moment_in_debye`](#qiskit.chemistry.results.ElectronicStructureResult.total_dipole_moment_in_debye "qiskit.chemistry.results.ElectronicStructureResult.total_dipole_moment_in_debye") | Returns total dipole of moment in Debye |
| [`total_energies`](#qiskit.chemistry.results.ElectronicStructureResult.total_energies "qiskit.chemistry.results.ElectronicStructureResult.total_energies") | Returns ground state energy if nuclear\_repulsion\_energy is available from driver |
### aux\_operator\_eigenvalues
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.aux_operator_eigenvalues">
return aux operator eigen values
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### clear
<Function id="qiskit.chemistry.results.ElectronicStructureResult.clear" signature="clear()">
**Return type**
`None`
</Function>
### combine
<Function id="qiskit.chemistry.results.ElectronicStructureResult.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\_dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.computed_dipole_moment">
Returns computed electronic part of dipole moment
**Return type**
`Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]]
</Attribute>
### computed\_energies
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.computed_energies">
Returns computed electronic part of ground state energy
**Return type**
`ndarray`
</Attribute>
### dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.dipole_moment">
Returns dipole moment
**Return type**
`Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]]
</Attribute>
### dipole\_moment\_in\_debye
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.dipole_moment_in_debye">
Returns dipole moment in Debye
**Return type**
`Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]]
</Attribute>
### eigenenergies
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.eigenenergies">
returns eigen energies
**Return type**
`Optional`\[`ndarray`]
</Attribute>
### eigenstates
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.eigenstates">
returns eigen states
**Return type**
`Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]]
</Attribute>
### electronic\_dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.electronic_dipole_moment">
Returns electronic dipole moment
**Return type**
`Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]]
</Attribute>
### electronic\_energies
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.electronic_energies">
Returns electronic part of ground state energy
**Return type**
`ndarray`
</Attribute>
### formatted
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.formatted">
Formatted result as a list of strings
**Return type**
`List`\[`str`]
</Attribute>
### frozen\_extracted\_dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.frozen_extracted_dipole_moment">
Returns frozen extracted part of dipole moment
**Return type**
`Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]]
</Attribute>
### frozen\_extracted\_energy
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.frozen_extracted_energy">
Returns frozen extracted part of ground state energy
**Return type**
`float`
</Attribute>
### get
<Function id="qiskit.chemistry.results.ElectronicStructureResult.get" signature="get(k[, d]) → D[k] if k in D, else d. d defaults to None." />
### groundenergy
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.groundenergy">
returns ground energy
**Return type**
`Optional`\[`float`]
</Attribute>
### groundstate
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.groundstate">
returns ground state
**Return type**
`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`]
</Attribute>
### hartree\_fock\_energy
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.hartree_fock_energy">
Returns Hartree-Fock energy
**Return type**
`float`
</Attribute>
### has\_dipole
<Function id="qiskit.chemistry.results.ElectronicStructureResult.has_dipole" signature="has_dipole()">
Returns whether dipole moment is present in result or not
**Return type**
`bool`
</Function>
### has\_observables
<Function id="qiskit.chemistry.results.ElectronicStructureResult.has_observables" signature="has_observables()">
Returns whether result has aux op observables such as spin, num particles
</Function>
### items
<Function id="qiskit.chemistry.results.ElectronicStructureResult.items" signature="items() → a set-like object providing a view on D’s items" />
### keys
<Function id="qiskit.chemistry.results.ElectronicStructureResult.keys" signature="keys() → a set-like object providing a view on D’s keys" />
### magnetization
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.magnetization">
Returns measured magnetization
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### nuclear\_dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.nuclear_dipole_moment">
Returns nuclear dipole moment X,Y,Z components in A.U when available from driver
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### nuclear\_repulsion\_energy
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.nuclear_repulsion_energy">
Returns nuclear repulsion energy when available from driver
**Return type**
`Optional`\[`float`]
</Attribute>
### num\_particles
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.num_particles">
Returns measured number of particles
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### ph\_extracted\_dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.ph_extracted_dipole_moment">
Returns particle hole extracted part of dipole moment
**Return type**
`Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]]
</Attribute>
### ph\_extracted\_energy
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.ph_extracted_energy">
Returns particle hole extracted part of ground state energy
**Return type**
`float`
</Attribute>
### pop
<Function id="qiskit.chemistry.results.ElectronicStructureResult.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.ElectronicStructureResult.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.ElectronicStructureResult.raw_result">
Returns the raw algorithm result.
**Return type**
`Optional`\[`AlgorithmResult`]
</Attribute>
### reverse\_dipole\_sign
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.reverse_dipole_sign">
Returns if electronic dipole moment sign should be reversed when adding to nuclear
**Return type**
`bool`
</Attribute>
### setdefault
<Function id="qiskit.chemistry.results.ElectronicStructureResult.setdefault" signature="setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />
### spin
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.spin">
Returns computed spin
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### total\_angular\_momentum
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.total_angular_momentum">
Returns total angular momentum (S^2)
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### total\_dipole\_moment
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.total_dipole_moment">
Returns total dipole of moment
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### total\_dipole\_moment\_in\_debye
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.total_dipole_moment_in_debye">
Returns total dipole of moment in Debye
**Return type**
`Optional`\[`List`\[`float`]]
</Attribute>
### total\_energies
<Attribute id="qiskit.chemistry.results.ElectronicStructureResult.total_energies">
Returns ground state energy if nuclear\_repulsion\_energy is available from driver
**Return type**
`ndarray`
</Attribute>
### update
<Function id="qiskit.chemistry.results.ElectronicStructureResult.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.ElectronicStructureResult.values" signature="values() → an object providing a view on D’s values" />
</Class>
Reference in New Issue View Git Blame Copy Permalink