165 lines
4.3 KiB
Plaintext
165 lines
4.3 KiB
Plaintext
---
|
||
title: MaximumLikelihoodAmplitudeEstimationResult
|
||
description: API reference for qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult
|
||
---
|
||
|
||
# MaximumLikelihoodAmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/amplitude_estimators/mlae.py" signature="MaximumLikelihoodAmplitudeEstimationResult" modifiers="class">
|
||
Bases: `qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`
|
||
|
||
The `MaximumLikelihoodAmplitudeEstimation` result object.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine" signature="MaximumLikelihoodAmplitudeEstimationResult.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.MaximumLikelihoodAmplitudeEstimationResult.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.MaximumLikelihoodAmplitudeEstimationResult.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.MaximumLikelihoodAmplitudeEstimationResult.confidence_interval_processed">
|
||
Return the post-processed confidence interval (95% interval by default).
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`float`, `float`]
|
||
</Attribute>
|
||
|
||
### estimation
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.estimation">
|
||
Return the estimation for the amplitude in $[0, 1]$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### estimation\_processed
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.estimation_processed">
|
||
Return the estimation for the amplitude after the post-processing has been applied.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### evaluation\_schedule
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.evaluation_schedule">
|
||
Return the evaluation schedule for the powers of the Grover operator.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`int`]
|
||
</Attribute>
|
||
|
||
### fisher\_information
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.fisher_information">
|
||
Return the Fisher information for the estimated amplitude.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### good\_counts
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.good_counts">
|
||
Return the percentage of good counts per circuit power.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`float`]
|
||
</Attribute>
|
||
|
||
### minimizer
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.minimizer">
|
||
Return the minimizer used for the search of the likelihood function.
|
||
|
||
**Return type**
|
||
|
||
`callable`
|
||
</Attribute>
|
||
|
||
### num\_oracle\_queries
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.num_oracle_queries">
|
||
Return the number of Grover oracle queries.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### post\_processing
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.post_processing">
|
||
Return a handle to the post processing function.
|
||
|
||
**Return type**
|
||
|
||
`Callable`\[\[`float`], `float`]
|
||
</Attribute>
|
||
|
||
### shots
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.shots">
|
||
Return the number of shots used. Is 1 for statevector-based simulations.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### theta
|
||
|
||
<Attribute id="qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.theta">
|
||
Return the estimate for the angle $\theta$.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
</Class>
|
||
|