105 lines
3.5 KiB
Plaintext
105 lines
3.5 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
|
||
---
|
||
|
||
# FasterAmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.algorithms.FasterAmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/algorithms/amplitude_estimators/fae.py" signature="FasterAmplitudeEstimationResult" modifiers="class">
|
||
Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult")
|
||
|
||
The result object for the Faster Amplitude Estimation algorithm.
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-algorithms-fasteramplitudeestimationresult-combine" />
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.FasterAmplitudeEstimationResult.combine" signature="FasterAmplitudeEstimationResult.combine(result)">
|
||
Any property from the argument that exists in the receiver is updated. :param result: Argument result with properties to be set.
|
||
|
||
**Raises**
|
||
|
||
**TypeError** – Argument is None
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### circuit\_results
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.circuit_results">
|
||
Return the circuit results. Can be a statevector or counts dictionary.
|
||
</Attribute>
|
||
|
||
### confidence\_interval
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.confidence_interval">
|
||
Return the confidence interval for the amplitude (95% interval by default).
|
||
</Attribute>
|
||
|
||
### confidence\_interval\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.confidence_interval_processed">
|
||
Return the post-processed confidence interval (95% interval by default).
|
||
</Attribute>
|
||
|
||
### estimation
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.estimation">
|
||
Return the estimation for the amplitude in $[0, 1]$.
|
||
</Attribute>
|
||
|
||
### estimation\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.estimation_processed">
|
||
Return the estimation for the amplitude after the post-processing has been applied.
|
||
</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.
|
||
</Attribute>
|
||
|
||
### num\_oracle\_queries
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.num_oracle_queries">
|
||
Return the number of Grover oracle queries.
|
||
</Attribute>
|
||
|
||
### num\_steps
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.num_steps">
|
||
Return the total number of steps taken in the algorithm.
|
||
</Attribute>
|
||
|
||
### post\_processing
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.post_processing">
|
||
Return a handle to the post processing function.
|
||
</Attribute>
|
||
|
||
### shots
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.shots">
|
||
Return the number of shots used. Is 1 for statevector-based simulations.
|
||
</Attribute>
|
||
|
||
### success\_probability
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.success_probability">
|
||
Return the success probability of the algorithm.
|
||
</Attribute>
|
||
|
||
### theta\_intervals
|
||
|
||
<Attribute id="qiskit.algorithms.FasterAmplitudeEstimationResult.theta_intervals">
|
||
Return the confidence intervals for the angles in each iteration.
|
||
</Attribute>
|
||
</Class>
|
||
|