179 lines
8.8 KiB
Plaintext
179 lines
8.8 KiB
Plaintext
---
|
||
title: FasterAmplitudeEstimationResult
|
||
description: API reference for qiskit.algorithms.FasterAmplitudeEstimationResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult
|
||
---
|
||
|
||
# qiskit.algorithms.FasterAmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.algorithms.FasterAmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/fae.py" signature="FasterAmplitudeEstimationResult" modifiers="class">
|
||
The result object for the Faster Amplitude Estimation algorithm.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.algorithms.FasterAmplitudeEstimationResult.__init__" signature="__init__()">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.algorithms.FasterAmplitudeEstimationResult.__init__ "qiskit.algorithms.FasterAmplitudeEstimationResult.__init__")() | Initialize self. |
|
||
| [`combine`](#qiskit.algorithms.FasterAmplitudeEstimationResult.combine "qiskit.algorithms.FasterAmplitudeEstimationResult.combine")(result) | Any property from the argument that exists in the receiver is updated. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||
| [`circuit_results`](#qiskit.algorithms.FasterAmplitudeEstimationResult.circuit_results "qiskit.algorithms.FasterAmplitudeEstimationResult.circuit_results") | Return the circuit results. |
|
||
| [`confidence_interval`](#qiskit.algorithms.FasterAmplitudeEstimationResult.confidence_interval "qiskit.algorithms.FasterAmplitudeEstimationResult.confidence_interval") | Return the confidence interval for the amplitude (95% interval by default). |
|
||
| [`confidence_interval_processed`](#qiskit.algorithms.FasterAmplitudeEstimationResult.confidence_interval_processed "qiskit.algorithms.FasterAmplitudeEstimationResult.confidence_interval_processed") | Return the post-processed confidence interval (95% interval by default). |
|
||
| [`estimation`](#qiskit.algorithms.FasterAmplitudeEstimationResult.estimation "qiskit.algorithms.FasterAmplitudeEstimationResult.estimation") | Return the estimation for the amplitude in $[0, 1]$. |
|
||
| [`estimation_processed`](#qiskit.algorithms.FasterAmplitudeEstimationResult.estimation_processed "qiskit.algorithms.FasterAmplitudeEstimationResult.estimation_processed") | Return the estimation for the amplitude after the post-processing has been applied. |
|
||
| [`num_first_state_steps`](#qiskit.algorithms.FasterAmplitudeEstimationResult.num_first_state_steps "qiskit.algorithms.FasterAmplitudeEstimationResult.num_first_state_steps") | Return the number of steps taken in the first step of algorithm. |
|
||
| [`num_oracle_queries`](#qiskit.algorithms.FasterAmplitudeEstimationResult.num_oracle_queries "qiskit.algorithms.FasterAmplitudeEstimationResult.num_oracle_queries") | Return the number of Grover oracle queries. |
|
||
| [`num_steps`](#qiskit.algorithms.FasterAmplitudeEstimationResult.num_steps "qiskit.algorithms.FasterAmplitudeEstimationResult.num_steps") | Return the total number of steps taken in the algorithm. |
|
||
| [`post_processing`](#qiskit.algorithms.FasterAmplitudeEstimationResult.post_processing "qiskit.algorithms.FasterAmplitudeEstimationResult.post_processing") | Return a handle to the post processing function. |
|
||
| [`shots`](#qiskit.algorithms.FasterAmplitudeEstimationResult.shots "qiskit.algorithms.FasterAmplitudeEstimationResult.shots") | Return the number of shots used. |
|
||
| [`success_probability`](#qiskit.algorithms.FasterAmplitudeEstimationResult.success_probability "qiskit.algorithms.FasterAmplitudeEstimationResult.success_probability") | Return the success probability of the algorithm. |
|
||
| [`theta_intervals`](#qiskit.algorithms.FasterAmplitudeEstimationResult.theta_intervals "qiskit.algorithms.FasterAmplitudeEstimationResult.theta_intervals") | Return the confidence intervals for the angles in each iteration. |
|
||
|
||
### circuit\_results
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.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.FasterAmplitudeEstimationResult.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.FasterAmplitudeEstimationResult.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.FasterAmplitudeEstimationResult.confidence_interval_processed">
|
||
Return the post-processed confidence interval (95% interval by default).
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`float`, `float`]
|
||
</Attribute>
|
||
|
||
### estimation
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.estimation">
|
||
Return the estimation for the amplitude in $[0, 1]$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### estimation\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.estimation_processed">
|
||
Return the estimation for the amplitude after the post-processing has been applied.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### num\_first\_state\_steps
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.num_first_state_steps">
|
||
Return the number of steps taken in the first step of algorithm.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_oracle\_queries
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.num_oracle_queries">
|
||
Return the number of Grover oracle queries.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_steps
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.num_steps">
|
||
Return the total number of steps taken in the algorithm.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### post\_processing
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.post_processing">
|
||
Return a handle to the post processing function.
|
||
|
||
**Return type**
|
||
|
||
`Callable`\[\[`float`], `float`]
|
||
</Attribute>
|
||
|
||
### shots
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.shots">
|
||
Return the number of shots used. Is 1 for statevector-based simulations.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### success\_probability
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.success_probability">
|
||
Return the success probability of the algorithm.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### theta\_intervals
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.theta_intervals">
|
||
Return the confidence intervals for the angles in each iteration.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`List`\[`float`]]
|
||
</Attribute>
|
||
</Class>
|
||
|