qiskit.algorithms.AmplitudeEstimationResult¶

class AmplitudeEstimationResult[source]¶

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

`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 (95% interval by default).
`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.
`max_probability`	Return the maximum sampling probability.
`measurements`	Return the measurements as integers with their measurement probability.
`mle`	Return the MLE for the amplitude, in $[0, 1]$.
`mle_processed`	Return the post-processed MLE for the amplitude.
`num_evaluation_qubits`	Returns the number of evaluation qubits.
`num_oracle_queries`	Return the number of Grover oracle queries.
`post_processing`	Return a handle to the post processing function.
`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.

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 (95% interval by default).

Return type: Tuple[float, 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 max_probability¶

Return the maximum sampling probability.

Return type: float

property measurements¶

Return the measurements as integers with their measurement probability.

Return type: Dict[int, float]

property mle¶

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

Return type: float

property mle_processed¶

Return the post-processed MLE for the amplitude.

Return type: float

property num_evaluation_qubits¶

Returns the number of evaluation qubits.

Return type: int

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 samples¶

Return the measurement samples with their measurement probability.

Return type: Dict[float, float]

property samples_processed¶

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

Return type: Dict[float, float]

property shots¶

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

Return type: int