qiskit.chemistry.results.ElectronicStructureResult
class ElectronicStructureResult(a_dict=None)
The electronic structure result.
__init__
__init__(a_dict=None)
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__([a_dict]) | Initialize self. |
clear() | rtypeNone |
combine(result) | Any property from the argument that exists in the receiver is updated. |
copy() | |
fromkeys(iterable[, value]) | |
get(k[,d]) | |
has_dipole() | Returns whether dipole moment is present in result or not |
has_observables() | Returns whether result has aux op observables such as spin, num particles |
items() | |
keys() | |
pop(key[, default]) | If key is not found, d is returned if given, otherwise KeyError is raised. |
popitem() | as a 2-tuple; but raise KeyError if D is empty. |
setdefault(k[,d]) | |
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() |
Attributes
aux_operator_eigenvalues | return aux operator eigen values |
computed_dipole_moment | Returns computed electronic part of dipole moment |
computed_energies | Returns computed electronic part of ground state energy |
dipole_moment | Returns dipole moment |
dipole_moment_in_debye | Returns dipole moment in Debye |
eigenenergies | returns eigen energies |
eigenstates | returns eigen states |
electronic_dipole_moment | Returns electronic dipole moment |
electronic_energies | Returns electronic part of ground state energy |
formatted | Formatted result as a list of strings |
frozen_extracted_dipole_moment | Returns frozen extracted part of dipole moment |
frozen_extracted_energy | Returns frozen extracted part of ground state energy |
groundenergy | returns ground energy |
groundstate | returns ground state |
hartree_fock_energy | Returns Hartree-Fock energy |
magnetization | Returns measured magnetization |
nuclear_dipole_moment | Returns nuclear dipole moment X,Y,Z components in A.U when available from driver |
nuclear_repulsion_energy | Returns nuclear repulsion energy when available from driver |
num_particles | Returns measured number of particles |
ph_extracted_dipole_moment | Returns particle hole extracted part of dipole moment |
ph_extracted_energy | Returns particle hole extracted part of ground state energy |
raw_result | Returns the raw algorithm result. |
reverse_dipole_sign | Returns if electronic dipole moment sign should be reversed when adding to nuclear |
spin | Returns computed spin |
total_angular_momentum | Returns total angular momentum (S^2) |
total_dipole_moment | Returns total dipole of moment |
total_dipole_moment_in_debye | Returns total dipole of moment in Debye |
total_energies | Returns ground state energy if nuclear_repulsion_energy is available from driver |
aux_operator_eigenvalues
return aux operator eigen values
Return type
Optional[List[float]]
clear
clear()
Return type
None
combine
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
computed_dipole_moment
Returns computed electronic part of dipole moment
Return type
Optional[List[Tuple[Optional[float], Optional[float], Optional[float]]]]
computed_energies
Returns computed electronic part of ground state energy
Return type
ndarray
dipole_moment
Returns dipole moment
Return type
Optional[List[Tuple[Optional[float], Optional[float], Optional[float]]]]
dipole_moment_in_debye
Returns dipole moment in Debye
Return type
Optional[List[Tuple[Optional[float], Optional[float], Optional[float]]]]
eigenenergies
returns eigen energies
Return type
Optional[ndarray]
eigenstates
returns eigen states
Return type
Optional[List[Union[str, dict, Result, list, ndarray, Statevector, QuantumCircuit, Instruction, OperatorBase]]]
electronic_dipole_moment
Returns electronic dipole moment
Return type
Optional[List[Tuple[Optional[float], Optional[float], Optional[float]]]]
electronic_energies
Returns electronic part of ground state energy
Return type
ndarray
formatted
Formatted result as a list of strings
Return type
List[str]
frozen_extracted_dipole_moment
Returns frozen extracted part of dipole moment
Return type
Optional[List[Tuple[Optional[float], Optional[float], Optional[float]]]]
frozen_extracted_energy
Returns frozen extracted part of ground state energy
Return type
float
get
get(k[, d]) → D[k] if k in D, else d. d defaults to None.
groundenergy
returns ground energy
Return type
Optional[float]
groundstate
returns ground state
Return type
Union[str, dict, Result, list, ndarray, Statevector, QuantumCircuit, Instruction, OperatorBase, None]
hartree_fock_energy
Returns Hartree-Fock energy
Return type
float
has_dipole
has_dipole()
Returns whether dipole moment is present in result or not
Return type
bool
has_observables
has_observables()
Returns whether result has aux op observables such as spin, num particles
items
items() → a set-like object providing a view on D’s items
keys
keys() → a set-like object providing a view on D’s keys
magnetization
Returns measured magnetization
Return type
Optional[List[float]]
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]]]
nuclear_repulsion_energy
Returns nuclear repulsion energy when available from driver
Return type
Optional[float]
num_particles
Returns measured number of particles
Return type
Optional[List[float]]
ph_extracted_dipole_moment
Returns particle hole extracted part of dipole moment
Return type
Optional[List[Tuple[Optional[float], Optional[float], Optional[float]]]]
ph_extracted_energy
Returns particle hole extracted part of ground state energy
Return type
float
pop
pop(key, default=None)
If key is not found, d is returned if given, otherwise KeyError is raised.
Return type
object
popitem
popitem()
as a 2-tuple; but raise KeyError if D is empty.
Return type
Tuple[object, object]
raw_result
Returns the raw algorithm result.
Return type
Optional[AlgorithmResult]
reverse_dipole_sign
Returns if electronic dipole moment sign should be reversed when adding to nuclear
Return type
bool
setdefault
setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D
spin
Returns computed spin
Return type
Optional[List[float]]
total_angular_momentum
Returns total angular momentum (S^2)
Return type
Optional[List[float]]
total_dipole_moment
Returns total dipole of moment
Return type
Optional[List[float]]
total_dipole_moment_in_debye
Returns total dipole of moment in Debye
Return type
Optional[List[float]]
total_energies
Returns ground state energy if nuclear_repulsion_energy is available from driver
Return type
ndarray
update
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
values
values() → an object providing a view on D’s values