qiskit.chemistry.results.VibronicStructureResult¶

class VibronicStructureResult(a_dict=None)[source]¶

The vibronic structure result.

__init__(a_dict=None)¶: 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])
`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
`aux_operator_eigenvalues`	return aux operator eigen values
`computed_vibronic_energies`	Returns computed electronic part of ground state energy
`eigenenergies`	returns eigen energies
`eigenstates`	returns eigen states
`formatted`	Formatted result as a list of strings
`groundenergy`	returns ground energy
`groundstate`	returns ground state
`num_occupied_modals_per_mode`	Returns the number of occupied modal per mode
`raw_result`	Returns the raw algorithm result.

property algorithm_result¶

Returns raw algorithm result

Return type: AlgorithmResult

property aux_operator_eigenvalues¶

return aux operator eigen values

Return type: Optional[List[float]]

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_vibronic_energies¶

Returns computed electronic part of ground state energy

Return type: ndarray

property eigenenergies¶

returns eigen energies

Return type: Optional[ndarray]

property eigenstates¶

returns eigen states

Return type: Optional[List[Union[str, dict, Result, list, ndarray, Statevector, QuantumCircuit, Instruction, OperatorBase]]]

property formatted¶

Formatted result as a list of strings

Return type: List[str]

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

property groundenergy¶

returns ground energy

Return type: Optional[float]

property groundstate¶

returns ground state

Return type: Union[str, dict, Result, list, ndarray, Statevector, QuantumCircuit, Instruction, OperatorBase, None]

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 num_occupied_modals_per_mode¶

Returns the number of occupied modal per mode

Return type: Optional[List[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 raw_result¶

Returns the raw algorithm result.

Return type: Optional[AlgorithmResult]

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in 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

Return type: None

values() → an object providing a view on D’s values¶