VibrationalStructureResult

class VibrationalStructureResult

Bases: EigenstateResult

The vibrational structure result.

Attributes

algorithm_result

Returns raw algorithm result

computed_vibrational_energies

Returns computed electronic part of ground state energy

groundenergy

Returns the lowest eigenvalue.

groundstate

Returns the lowest eigenstate.

num_occupied_modals_per_mode

Returns the number of occupied modal per mode

Methods

combine(result)

Any property from the argument that exists in the receiver is updated. :param result: Argument result with properties to be set.

Raises:

TypeError – Argument is None

formatted()

Formatted result as a list of strings

Return type:

List[str]

classmethod from_eigensolver_result(raw_result)

Constructs an EigenstateResult from an EigensolverResult.

Parameters:

raw_result (EigensolverResult) – the raw result from which to build the EigenstateResult.

Returns:

The constructed EigenstateResult.

Return type:

EigenstateResult

classmethod from_minimum_eigensolver_result(raw_result)

Constructs an EigenstateResult from an MinimumEigensolverResult.

Parameters:

raw_result (MinimumEigensolverResult) – the raw result from which to build the EigenstateResult.

Returns:

The constructed EigenstateResult.

Return type:

EigenstateResult

classmethod from_result(raw_result)

Constructs an EigenstateResult from another result type.

Parameters:

raw_result (EigenstateResult | EigensolverResult | MinimumEigensolverResult) – the raw result from which to build the new one.

Raises:

TypeError – when an unsupported result type is provided as input.

Returns:

The constructed EigenstateResult.

Return type:

EigenstateResult