qiskit.chemistry.core.MolecularGroundStateResult¶

class MolecularGroundStateResult(a_dict=None)[source]¶

Molecular Ground State Energy Result.

Energies are in Hartree and dipole moments in A.U unless otherwise stated.

__init__(a_dict=None)[source]¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`([a_dict])	Initialize self.
`clear`()	rtype `None`
`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

`algorithm_result`	Returns raw algorithm result
`computed_dipole_moment`	Returns computed electronic part of dipole moment
`computed_electronic_energy`	Returns computed electronic part of ground state energy
`dipole_moment`	Returns dipole moment
`dipole_moment_in_debye`	Returns dipole moment in Debye
`electronic_dipole_moment`	Returns electronic dipole moment
`electronic_energy`	Returns electronic part of ground state energy
`energy`	Returns ground state energy if nuclear_repulsion_energy is available from driver
`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
`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
`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

property algorithm_result¶

Returns raw algorithm result

Return type: AlgorithmResult

clear()¶

Return type: None

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

property computed_dipole_moment¶

Returns computed electronic part of dipole moment

Return type: Optional[Tuple[Optional[float], Optional[float], Optional[float]]]

property computed_electronic_energy¶

Returns computed electronic part of ground state energy

Return type: float

property dipole_moment¶

Returns dipole moment

Return type: Optional[Tuple[Optional[float], Optional[float], Optional[float]]]

property dipole_moment_in_debye¶

Returns dipole moment in Debye

Return type: Optional[Tuple[Optional[float], Optional[float], Optional[float]]]

property electronic_dipole_moment¶

Returns electronic dipole moment

Return type: Optional[Tuple[Optional[float], Optional[float], Optional[float]]]

property electronic_energy¶

Returns electronic part of ground state energy

Return type: float

property energy¶

Returns ground state energy if nuclear_repulsion_energy is available from driver

Return type: Optional[float]

property formatted¶

Formatted result as a list of strings

Return type: List[str]

property frozen_extracted_dipole_moment¶

Returns frozen extracted part of dipole moment

Return type: Optional[Tuple[Optional[float], Optional[float], Optional[float]]]

property frozen_extracted_energy¶

Returns frozen extracted part of ground state energy

Return type: float

get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶

property hartree_fock_energy¶

Returns Hartree-Fock energy

Return type: float

has_dipole()[source]¶

Returns whether dipole moment is present in result or not

Return type: bool

has_observables()[source]¶: Returns whether result has aux op observables such as spin, num particles

items() → a set-like object providing a view on D’s items¶

keys() → a set-like object providing a view on D’s keys¶

property magnetization¶

Returns measured magnetization

Return type: Optional[float]

property 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]]]

property nuclear_repulsion_energy¶

Returns nuclear repulsion energy when available from driver

Return type: Optional[float]

property num_particles¶

Returns measured number of particles

Return type: Optional[float]

property ph_extracted_dipole_moment¶

Returns particle hole extracted part of dipole moment

Return type: Optional[Tuple[Optional[float], Optional[float], Optional[float]]]

property ph_extracted_energy¶

Returns particle hole extracted part of ground state energy

Return type: float

pop(key, default=None)¶

If key is not found, d is returned if given, otherwise KeyError is raised.

Return type: object

popitem()¶

as a 2-tuple; but raise KeyError if D is empty.

Return type: Tuple[object, object]

property reverse_dipole_sign¶

Returns if electronic dipole moment sign should be reversed when adding to nuclear

Return type: bool

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

property spin¶

Returns computed spin

Return type: Optional[float]

property total_angular_momentum¶

Returns total angular momentum (S^2)

Return type: Optional[float]

property total_dipole_moment¶

Returns total dipole of moment

Return type: Optional[float]

property total_dipole_moment_in_debye¶

Returns total dipole of moment in Debye

Return type: Optional[float]

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() → an object providing a view on D’s values¶