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.

qiskit.algorithms.IterativeAmplitudeEstimationResult

class IterativeAmplitudeEstimationResult

GitHub

The IterativeAmplitudeEstimation 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

alphaReturn the confidence level α\alpha.
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.
epsilon_estimatedReturn the estimated half-width of the confidence interval.
epsilon_estimated_processedReturn the post-processed estimated half-width of the confidence interval.
epsilon_targetReturn the target half-width of the confidence interval.
estimate_intervalsReturn the confidence intervals for the estimate in each iteration.
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.
num_oracle_queriesReturn the number of Grover oracle queries.
post_processingReturn a handle to the post processing function.
powersReturn the powers of the Grover operator in each iteration.
ratiosReturn the ratios Ki+1/KiK_{i+1}/K_{i} for each iteration ii.
shotsReturn the number of shots used.
theta_intervalsReturn the confidence intervals for the angles in each iteration.

alpha

Return the confidence level α\alpha.

Return type

float

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.

Return type

Tuple[float, float]

epsilon_estimated

Return the estimated half-width of the confidence interval.

Return type

float

epsilon_estimated_processed

Return the post-processed estimated half-width of the confidence interval.

Return type

float

epsilon_target

Return the target half-width of the confidence interval.

Return type

float

estimate_intervals

Return the confidence intervals for the estimate in each iteration.

Return type

List[List[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

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]

powers

Return the powers of the Grover operator in each iteration.

Return type

List[int]

ratios

Return the ratios Ki+1/KiK_{i+1}/K_{i} for each iteration ii.

Return type

List[float]

shots

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

Return type

int

theta_intervals

Return the confidence intervals for the angles in each iteration.

Return type

List[List[float]]

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