VibronicStructureResult
class VibronicStructureResult(a_dict=None)
Bases: qiskit.chemistry.results.eigenstate_result.EigenstateResult
The vibronic structure result.
Methods
clear
VibronicStructureResult.clear()
Return type
None
combine
VibronicStructureResult.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
copy
VibronicStructureResult.copy()
fromkeys
classmethod VibronicStructureResult.fromkeys(iterable, value=None)
get
VibronicStructureResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.
items
VibronicStructureResult.items() → a set-like object providing a view on D’s items
keys
VibronicStructureResult.keys() → a set-like object providing a view on D’s keys
pop
VibronicStructureResult.pop(key, default=None)
If key is not found, d is returned if given, otherwise KeyError is raised.
Return type
object
popitem
VibronicStructureResult.popitem()
as a 2-tuple; but raise KeyError if D is empty.
Return type
Tuple[object, object]
setdefault
VibronicStructureResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D
update
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
Return type
None
values
VibronicStructureResult.values() → an object providing a view on D’s values
Attributes
algorithm_result
Returns raw algorithm result
Return type
AlgorithmResult
aux_operator_eigenvalues
return aux operator eigen values
Return type
Optional[List[float]]
computed_vibronic_energies
Returns computed electronic part of ground state energy
Return type
ndarray
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]]]
formatted
Formatted result as a list of strings
Return type
List[str]
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]
num_occupied_modals_per_mode
Returns the number of occupied modal per mode
Return type
Optional[List[float]]
raw_result
Returns the raw algorithm result.
Return type
Optional[AlgorithmResult]