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

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

qiskit.algorithms.AmplitudeEstimationResult

class AmplitudeEstimationResult

GitHub

The AmplitudeEstimation result object.

__init__

__init__()

Initialize self. See help(type(self)) for accurate signature.


Methods

__init__()Initialize self.
combine(result)Any property from the argument that exists in the receiver is updated.

Attributes

circuit_resultsReturn the circuit results.
confidence_intervalReturn the confidence interval for the amplitude (95% interval by default).
confidence_interval_processedReturn the post-processed confidence interval (95% interval by default).
estimationReturn the estimation for the amplitude in [0,1][0, 1].
estimation_processedReturn the estimation for the amplitude after the post-processing has been applied.
max_probabilityReturn the maximum sampling probability.
measurementsReturn the measurements as integers with their measurement probability.
mleReturn the MLE for the amplitude, in [0,1][0, 1].
mle_processedReturn the post-processed MLE for the amplitude.
num_evaluation_qubitsReturns the number of evaluation qubits.
num_oracle_queriesReturn the number of Grover oracle queries.
post_processingReturn a handle to the post processing function.
samplesReturn the measurement samples with their measurement probability.
samples_processedReturn the post-processed measurement samples with their measurement probability.
shotsReturn the number of shots used.

circuit_results

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

Return type

Union[ndarray, Dict[str, int], None]

combine

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

confidence_interval

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

Return type

Tuple[float, float]

confidence_interval_processed

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

Return type

Tuple[float, float]

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.

Return type

Dict[int, float]

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.

Return type

Dict[float, float]

samples_processed

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

Return type

Dict[float, float]

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.