185 lines
4.4 KiB
Plaintext
185 lines
4.4 KiB
Plaintext
---
|
||
title: AmplitudeEstimationResult
|
||
description: API reference for qiskit.algorithms.AmplitudeEstimationResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.AmplitudeEstimationResult
|
||
---
|
||
|
||
# AmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.algorithms.AmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/ae.py" signature="AmplitudeEstimationResult" modifiers="class">
|
||
Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`
|
||
|
||
The `AmplitudeEstimation` result object.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.AmplitudeEstimationResult.combine" signature="AmplitudeEstimationResult.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
|
||
|
||
### circuit\_results
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.circuit_results">
|
||
Return the circuit results. Can be a statevector or counts dictionary.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`]
|
||
</Attribute>
|
||
|
||
### confidence\_interval
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.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.AmplitudeEstimationResult.confidence_interval_processed">
|
||
Return the post-processed confidence interval (95% interval by default).
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`float`, `float`]
|
||
</Attribute>
|
||
|
||
### estimation
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.estimation">
|
||
Return the estimation for the amplitude in $[0, 1]$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### estimation\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.estimation_processed">
|
||
Return the estimation for the amplitude after the post-processing has been applied.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### max\_probability
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.max_probability">
|
||
Return the maximum sampling probability.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### measurements
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.measurements">
|
||
Return the measurements as integers with their measurement probability.
|
||
|
||
**Return type**
|
||
|
||
`Dict`\[`int`, `float`]
|
||
</Attribute>
|
||
|
||
### mle
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.mle">
|
||
Return the MLE for the amplitude, in $\[0, 1]\$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### mle\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.mle_processed">
|
||
Return the post-processed MLE for the amplitude.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### num\_evaluation\_qubits
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.num_evaluation_qubits">
|
||
Returns the number of evaluation qubits.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### num\_oracle\_queries
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.num_oracle_queries">
|
||
Return the number of Grover oracle queries.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### post\_processing
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.post_processing">
|
||
Return a handle to the post processing function.
|
||
|
||
**Return type**
|
||
|
||
`Callable`\[\[`float`], `float`]
|
||
</Attribute>
|
||
|
||
### samples
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.samples">
|
||
Return the measurement samples with their measurement probability.
|
||
|
||
**Return type**
|
||
|
||
`Dict`\[`float`, `float`]
|
||
</Attribute>
|
||
|
||
### samples\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.samples_processed">
|
||
Return the post-processed measurement samples with their measurement probability.
|
||
|
||
**Return type**
|
||
|
||
`Dict`\[`float`, `float`]
|
||
</Attribute>
|
||
|
||
### shots
|
||
|
||
<Attribute id="qiskit.algorithms.AmplitudeEstimationResult.shots">
|
||
Return the number of shots used. Is 1 for statevector-based simulations.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
</Class>
|
||
|