42 lines
1.9 KiB
Plaintext
42 lines
1.9 KiB
Plaintext
---
|
||
title: AmplitudeEstimator
|
||
description: API reference for qiskit.algorithms.AmplitudeEstimator
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.AmplitudeEstimator
|
||
---
|
||
|
||
# qiskit.algorithms.AmplitudeEstimator
|
||
|
||
<Class id="qiskit.algorithms.AmplitudeEstimator" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py" signature="AmplitudeEstimator" modifiers="class">
|
||
The Amplitude Estimation interface.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.algorithms.AmplitudeEstimator.__init__" signature="__init__()">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||
| [`__init__`](#qiskit.algorithms.AmplitudeEstimator.__init__ "qiskit.algorithms.AmplitudeEstimator.__init__")() | Initialize self. |
|
||
| [`estimate`](#qiskit.algorithms.AmplitudeEstimator.estimate "qiskit.algorithms.AmplitudeEstimator.estimate")(estimation\_problem) | Run the amplitude estimation algorithm. |
|
||
|
||
### estimate
|
||
|
||
<Function id="qiskit.algorithms.AmplitudeEstimator.estimate" signature="estimate(estimation_problem)" modifiers="abstract">
|
||
Run the amplitude estimation algorithm.
|
||
|
||
**Parameters**
|
||
|
||
**estimation\_problem** (`EstimationProblem`) – An `EstimationProblem` containing all problem-relevant information such as the state preparation and the objective qubits.
|
||
|
||
**Return type**
|
||
|
||
`AmplitudeEstimatorResult`
|
||
</Function>
|
||
</Class>
|
||
|