qiskit-documentation/docs/api/qiskit/0.29/qiskit.chemistry.core.Molec...

349 lines
9.5 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

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: MolecularGroundStateResult
description: API reference for qiskit.chemistry.core.MolecularGroundStateResult
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.chemistry.core.MolecularGroundStateResult
---
# MolecularGroundStateResult
<Class id="qiskit.chemistry.core.MolecularGroundStateResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/core/chemistry_operator.py" signature="MolecularGroundStateResult(a_dict=None)" modifiers="class">
Bases: `qiskit.chemistry.core.chemistry_operator.MolecularChemistryResult`
Molecular Ground State Energy Result.
Energies are in Hartree and dipole moments in A.U unless otherwise stated.
## Methods
### clear
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.clear" signature="MolecularGroundStateResult.clear()">
**Return type**
`None`
</Function>
### combine
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.combine" signature="MolecularGroundStateResult.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.core.MolecularGroundStateResult.copy" signature="MolecularGroundStateResult.copy()" />
### fromkeys
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.fromkeys" signature="MolecularGroundStateResult.fromkeys(iterable, value=None)" modifiers="classmethod" />
### get
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.get" signature="MolecularGroundStateResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None." />
### has\_dipole
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.has_dipole" signature="MolecularGroundStateResult.has_dipole()">
Returns whether dipole moment is present in result or not
**Return type**
`bool`
</Function>
### has\_observables
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.has_observables" signature="MolecularGroundStateResult.has_observables()">
Returns whether result has aux op observables such as spin, num particles
</Function>
### items
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.items" signature="MolecularGroundStateResult.items() → a set-like object providing a view on Ds items" />
### keys
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.keys" signature="MolecularGroundStateResult.keys() → a set-like object providing a view on Ds keys" />
### pop
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.pop" signature="MolecularGroundStateResult.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.core.MolecularGroundStateResult.popitem" signature="MolecularGroundStateResult.popitem()">
as a 2-tuple; but raise KeyError if D is empty.
**Return type**
`Tuple`\[`object`, `object`]
</Function>
### setdefault
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.setdefault" signature="MolecularGroundStateResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />
### update
<Function id="qiskit.chemistry.core.MolecularGroundStateResult.update" signature="MolecularGroundStateResult.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.core.MolecularGroundStateResult.values" signature="MolecularGroundStateResult.values() → an object providing a view on Ds values" />
## Attributes
### algorithm\_result
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.algorithm_result">
Returns raw algorithm result
**Return type**
`AlgorithmResult`
</Attribute>
### computed\_dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.computed_dipole_moment">
Returns computed electronic part of dipole moment
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### computed\_electronic\_energy
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.computed_electronic_energy">
Returns computed electronic part of ground state energy
**Return type**
`float`
</Attribute>
### dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.dipole_moment">
Returns dipole moment
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### dipole\_moment\_in\_debye
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.dipole_moment_in_debye">
Returns dipole moment in Debye
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### electronic\_dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.electronic_dipole_moment">
Returns electronic dipole moment
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### electronic\_energy
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.electronic_energy">
Returns electronic part of ground state energy
**Return type**
`float`
</Attribute>
### energy
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.energy">
Returns ground state energy if nuclear\_repulsion\_energy is available from driver
**Return type**
`Optional`\[`float`]
</Attribute>
### formatted
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.formatted">
Formatted result as a list of strings
**Return type**
`List`\[`str`]
</Attribute>
### frozen\_extracted\_dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.frozen_extracted_dipole_moment">
Returns frozen extracted part of dipole moment
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### frozen\_extracted\_energy
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.frozen_extracted_energy">
Returns frozen extracted part of ground state energy
**Return type**
`float`
</Attribute>
### hartree\_fock\_energy
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.hartree_fock_energy">
Returns Hartree-Fock energy
**Return type**
`float`
</Attribute>
### magnetization
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.magnetization">
Returns measured magnetization
**Return type**
`Optional`\[`float`]
</Attribute>
### nuclear\_dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.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.core.MolecularGroundStateResult.nuclear_repulsion_energy">
Returns nuclear repulsion energy when available from driver
**Return type**
`Optional`\[`float`]
</Attribute>
### num\_particles
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.num_particles">
Returns measured number of particles
**Return type**
`Optional`\[`float`]
</Attribute>
### ph\_extracted\_dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.ph_extracted_dipole_moment">
Returns particle hole extracted part of dipole moment
**Return type**
`Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]
</Attribute>
### ph\_extracted\_energy
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.ph_extracted_energy">
Returns particle hole extracted part of ground state energy
**Return type**
`float`
</Attribute>
### reverse\_dipole\_sign
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.reverse_dipole_sign">
Returns if electronic dipole moment sign should be reversed when adding to nuclear
**Return type**
`bool`
</Attribute>
### spin
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.spin">
Returns computed spin
**Return type**
`Optional`\[`float`]
</Attribute>
### total\_angular\_momentum
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.total_angular_momentum">
Returns total angular momentum (S^2)
**Return type**
`Optional`\[`float`]
</Attribute>
### total\_dipole\_moment
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.total_dipole_moment">
Returns total dipole of moment
**Return type**
`Optional`\[`float`]
</Attribute>
### total\_dipole\_moment\_in\_debye
<Attribute id="qiskit.chemistry.core.MolecularGroundStateResult.total_dipole_moment_in_debye">
Returns total dipole of moment in Debye
**Return type**
`Optional`\[`float`]
</Attribute>
</Class>