qiskit.algorithms.IterativeAmplitudeEstimationResult¶

class IterativeAmplitudeEstimationResult[source]¶

The IterativeAmplitudeEstimation result object.

__init__()[source]¶: 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

`alpha`	Return the confidence level \(\alpha\).
`circuit_results`	Return the circuit results.
`confidence_interval`	Return the confidence interval for the amplitude (95% interval by default).
`confidence_interval_processed`	Return the post-processed confidence interval.
`epsilon_estimated`	Return the estimated half-width of the confidence interval.
`epsilon_estimated_processed`	Return the post-processed estimated half-width of the confidence interval.
`epsilon_target`	Return the target half-width of the confidence interval.
`estimate_intervals`	Return the confidence intervals for the estimate in each iteration.
`estimation`	Return the estimation for the amplitude in \([0, 1]\).
`estimation_processed`	Return the estimation for the amplitude after the post-processing has been applied.
`num_oracle_queries`	Return the number of Grover oracle queries.
`post_processing`	Return a handle to the post processing function.
`powers`	Return the powers of the Grover operator in each iteration.
`ratios`	Return the ratios \(K_{i+1}/K_{i}\) for each iteration \(i\).
`shots`	Return the number of shots used.
`theta_intervals`	Return the confidence intervals for the angles in each iteration.

property alpha¶

Return the confidence level \(\alpha\).

Return type: float

property circuit_results¶

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

Return type: Union[ndarray, Dict[str, int], None]

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

property confidence_interval¶

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

Return type: Tuple[float, float]

property confidence_interval_processed¶

Return the post-processed confidence interval.

Return type: Tuple[float, float]

property epsilon_estimated¶

Return the estimated half-width of the confidence interval.

Return type: float

property epsilon_estimated_processed¶

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

Return type: float

property epsilon_target¶

Return the target half-width of the confidence interval.

Return type: float

property estimate_intervals¶

Return the confidence intervals for the estimate in each iteration.

Return type: List[List[float]]

property estimation¶

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

Return type: float

property estimation_processed¶

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

Return type: float

property num_oracle_queries¶

Return the number of Grover oracle queries.

Return type: int

property post_processing¶

Return a handle to the post processing function.

Return type: Callable[[float], float]

property powers¶

Return the powers of the Grover operator in each iteration.

Return type: List[int]

property ratios¶

Return the ratios \(K_{i+1}/K_{i}\) for each iteration \(i\).

Return type: List[float]

property shots¶

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

Return type: int

property theta_intervals¶

Return the confidence intervals for the angles in each iteration.

Return type: List[List[float]]