167 lines
4.6 KiB
Plaintext
167 lines
4.6 KiB
Plaintext
---
|
||
title: IterativeAmplitudeEstimationResult
|
||
description: API reference for qiskit.algorithms.IterativeAmplitudeEstimationResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult
|
||
---
|
||
|
||
# IterativeAmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.algorithms.IterativeAmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.22/qiskit/algorithms/amplitude_estimators/iae.py" signature="IterativeAmplitudeEstimationResult" modifiers="class">
|
||
Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult")
|
||
|
||
The `IterativeAmplitudeEstimation` result object.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.IterativeAmplitudeEstimationResult.combine" signature="IterativeAmplitudeEstimationResult.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`
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### alpha
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.alpha">
|
||
Return the confidence level $\alpha$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### circuit\_results
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.circuit_results">
|
||
Return the circuit results. Can be a statevector or counts dictionary.
|
||
</Attribute>
|
||
|
||
### confidence\_interval
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval">
|
||
Return the confidence interval for the amplitude (95% interval by default).
|
||
</Attribute>
|
||
|
||
### confidence\_interval\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval_processed">
|
||
Return the post-processed confidence interval.
|
||
</Attribute>
|
||
|
||
### epsilon\_estimated
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_estimated">
|
||
Return the estimated half-width of the confidence interval.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### epsilon\_estimated\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_estimated_processed">
|
||
Return the post-processed estimated half-width of the confidence interval.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### epsilon\_target
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_target">
|
||
Return the target half-width of the confidence interval.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### estimate\_intervals
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.estimate_intervals">
|
||
Return the confidence intervals for the estimate in each iteration.
|
||
</Attribute>
|
||
|
||
### estimation
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.estimation">
|
||
Return the estimation for the amplitude in $[0, 1]$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### estimation\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.estimation_processed">
|
||
Return the estimation for the amplitude after the post-processing has been applied.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### num\_oracle\_queries
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.num_oracle_queries">
|
||
Return the number of Grover oracle queries.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### post\_processing
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.post_processing">
|
||
Return a handle to the post processing function.
|
||
|
||
**Return type**
|
||
|
||
`Callable`\[\[`float`], `float`]
|
||
</Attribute>
|
||
|
||
### powers
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.powers">
|
||
Return the powers of the Grover operator in each iteration.
|
||
</Attribute>
|
||
|
||
### ratios
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.ratios">
|
||
Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$.
|
||
</Attribute>
|
||
|
||
### shots
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.shots">
|
||
Return the number of shots used. Is 1 for statevector-based simulations.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### theta\_intervals
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.theta_intervals">
|
||
Return the confidence intervals for the angles in each iteration.
|
||
</Attribute>
|
||
</Class>
|
||
|