Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

SamplingVQEResult

class SamplingVQEResult

GitHub

Bases: qiskit.algorithms.variational_algorithm.VariationalResult, qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult

VQE Result.


Methods

combine

SamplingVQEResult.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


Attributes

aux_operators_evaluated

Return aux operator expectation values and metadata.

These are formatted as (mean, metadata).

best_measurement

Return the best measurement over the entire optimization.

Possesses keys: state, bitstring, value, probability.

cost_function_evals

Returns number of cost optimizer evaluations

Return type

int | None

eigenstate

Return the quasi-distribution sampled from the final state.

The ansatz is sampled when parameterized with the optimal parameters that where obtained computing the minimum eigenvalue. The keys represent a measured classical value and the value is a float for the quasi-probability of that result.

Return type

QuasiDistribution | None

eigenvalue

Return the approximation to the eigenvalue.

Return type

complex | None

optimal_circuit

The optimal circuits. Along with the optimal parameters, these can be used to retrieve the minimum eigenstate.

Return type

QuantumCircuit

optimal_parameters

Returns the optimal parameters in a dictionary

Return type

Optional[Dict]

optimal_point

Returns optimal point

Return type

Optional[ndarray]

optimal_value

Returns optimal value

Return type

Optional[float]

optimizer_evals

Returns number of optimizer evaluations

Return type

Optional[int]

optimizer_result

Returns the optimizer result

Return type

Optional[OptimizerResult]

optimizer_time

Returns time taken for optimization

Return type

Optional[float]

Was this page helpful?
Report a bug or request content on GitHub.