Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK. Go to the latest version.

AmplitudeEstimationResult

class AmplitudeEstimationResult

GitHub

Bases: qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult

The AmplitudeEstimation result object.


Methods

combine

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

circuit_results

Return the circuit results. Can be a statevector or counts dictionary.

confidence_interval

Return the confidence interval for the amplitude (95% interval by default).

confidence_interval_processed

Return the post-processed confidence interval (95% interval by default).

estimation

Return the estimation for the amplitude in [0,1][0, 1].

Return type

float

estimation_processed

Return the estimation for the amplitude after the post-processing has been applied.

Return type

float

max_probability

Return the maximum sampling probability.

Return type

float

measurements

Return the measurements as integers with their measurement probability.

mle

Return the MLE for the amplitude, in [0,1][0, 1].

Return type

float

mle_processed

Return the post-processed MLE for the amplitude.

Return type

float

num_evaluation_qubits

Returns the number of evaluation qubits.

Return type

int

num_oracle_queries

Return the number of Grover oracle queries.

Return type

int

post_processing

Return a handle to the post processing function.

Return type

Callable[[float], float]

samples

Return the measurement samples with their measurement probability.

samples_processed

Return the post-processed measurement samples with their measurement probability.

shots

Return the number of shots used. Is 1 for statevector-based simulations.

Return type

int

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