223 lines
11 KiB
Plaintext
223 lines
11 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
|
||
---
|
||
|
||
# qiskit.algorithms.IterativeAmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.algorithms.IterativeAmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/iae.py" signature="IterativeAmplitudeEstimationResult" modifiers="class">
|
||
The `IterativeAmplitudeEstimation` result object.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.algorithms.IterativeAmplitudeEstimationResult.__init__" signature="__init__()">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.__init__ "qiskit.algorithms.IterativeAmplitudeEstimationResult.__init__")() | Initialize self. |
|
||
| [`combine`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.combine "qiskit.algorithms.IterativeAmplitudeEstimationResult.combine")(result) | Any property from the argument that exists in the receiver is updated. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||
| [`alpha`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.alpha "qiskit.algorithms.IterativeAmplitudeEstimationResult.alpha") | Return the confidence level $\alpha$. |
|
||
| [`circuit_results`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.circuit_results "qiskit.algorithms.IterativeAmplitudeEstimationResult.circuit_results") | Return the circuit results. |
|
||
| [`confidence_interval`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval "qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval") | Return the confidence interval for the amplitude (95% interval by default). |
|
||
| [`confidence_interval_processed`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval_processed "qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval_processed") | Return the post-processed confidence interval. |
|
||
| [`epsilon_estimated`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_estimated "qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_estimated") | Return the estimated half-width of the confidence interval. |
|
||
| [`epsilon_estimated_processed`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_estimated_processed "qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_estimated_processed") | Return the post-processed estimated half-width of the confidence interval. |
|
||
| [`epsilon_target`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_target "qiskit.algorithms.IterativeAmplitudeEstimationResult.epsilon_target") | Return the target half-width of the confidence interval. |
|
||
| [`estimate_intervals`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.estimate_intervals "qiskit.algorithms.IterativeAmplitudeEstimationResult.estimate_intervals") | Return the confidence intervals for the estimate in each iteration. |
|
||
| [`estimation`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.estimation "qiskit.algorithms.IterativeAmplitudeEstimationResult.estimation") | Return the estimation for the amplitude in $[0, 1]$. |
|
||
| [`estimation_processed`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.estimation_processed "qiskit.algorithms.IterativeAmplitudeEstimationResult.estimation_processed") | Return the estimation for the amplitude after the post-processing has been applied. |
|
||
| [`num_oracle_queries`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.num_oracle_queries "qiskit.algorithms.IterativeAmplitudeEstimationResult.num_oracle_queries") | Return the number of Grover oracle queries. |
|
||
| [`post_processing`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.post_processing "qiskit.algorithms.IterativeAmplitudeEstimationResult.post_processing") | Return a handle to the post processing function. |
|
||
| [`powers`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.powers "qiskit.algorithms.IterativeAmplitudeEstimationResult.powers") | Return the powers of the Grover operator in each iteration. |
|
||
| [`ratios`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.ratios "qiskit.algorithms.IterativeAmplitudeEstimationResult.ratios") | Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$. |
|
||
| [`shots`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.shots "qiskit.algorithms.IterativeAmplitudeEstimationResult.shots") | Return the number of shots used. |
|
||
| [`theta_intervals`](#qiskit.algorithms.IterativeAmplitudeEstimationResult.theta_intervals "qiskit.algorithms.IterativeAmplitudeEstimationResult.theta_intervals") | Return the confidence intervals for the angles in each iteration. |
|
||
|
||
### 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.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`]
|
||
</Attribute>
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.IterativeAmplitudeEstimationResult.combine" signature="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>
|
||
|
||
### confidence\_interval
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval">
|
||
Return the confidence interval for the amplitude (95% interval by default).
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`float`, `float`]
|
||
</Attribute>
|
||
|
||
### confidence\_interval\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.confidence_interval_processed">
|
||
Return the post-processed confidence interval.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`float`, `float`]
|
||
</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.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`List`\[`float`]]
|
||
</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.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`int`]
|
||
</Attribute>
|
||
|
||
### ratios
|
||
|
||
<Attribute id="qiskit.algorithms.IterativeAmplitudeEstimationResult.ratios">
|
||
Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`float`]
|
||
</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.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`List`\[`float`]]
|
||
</Attribute>
|
||
</Class>
|
||
|