EigenstateResult

class EigenstateResult

Bases: AlgorithmResult

The eigenstate result interface.

The following attributes can be read and updated once the EigenstateResult object has been constructed.

eigenvalues

the computed eigenvalues.

Type:

np.ndarray | None

eigenstates

the eigenstates belonging to each of the computed eigenvalues.

Type:

list[tuple[QuantumCircuit, Sequence[float] | None]] | None

aux_operators_evaluated

the evaluated aux operators.

Type:

list[ListOrDict[complex]] | None

raw_result

the raw result, wrapped by this EigenstateResult.

Type:

AlgorithmResult | None

formatting_precision

the number of decimal places to use when formatting the result for printing.

Type:

int

Attributes

groundenergy

Returns the lowest eigenvalue.

groundstate

Returns the lowest eigenstate.

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

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