221 lines
6.1 KiB
Plaintext
221 lines
6.1 KiB
Plaintext
---
|
||
title: IterativeAmplitudeEstimationResult
|
||
description: API reference for qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult
|
||
---
|
||
|
||
# IterativeAmplitudeEstimationResult
|
||
|
||
<Class id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/algorithms/amplitude_estimators/iqae.py" signature="IterativeAmplitudeEstimationResult(a_dict=None)" modifiers="class">
|
||
Bases: `qiskit.aqua.algorithms.amplitude_estimators.ae_algorithm.AmplitudeEstimationAlgorithmResult`
|
||
|
||
IterativeAmplitudeEstimation Result.
|
||
|
||
## Methods
|
||
|
||
### clear
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.clear" signature="IterativeAmplitudeEstimationResult.clear()">
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.combine" signature="IterativeAmplitudeEstimationResult.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>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.copy" signature="IterativeAmplitudeEstimationResult.copy()" />
|
||
|
||
### from\_dict
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.from_dict" signature="IterativeAmplitudeEstimationResult.from_dict(a_dict)" modifiers="static">
|
||
create new object from a dictionary
|
||
|
||
**Return type**
|
||
|
||
`IterativeAmplitudeEstimationResult`
|
||
</Function>
|
||
|
||
### fromkeys
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.fromkeys" signature="IterativeAmplitudeEstimationResult.fromkeys(iterable, value=None)" modifiers="classmethod" />
|
||
|
||
### get
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.get" signature="IterativeAmplitudeEstimationResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None." />
|
||
|
||
### items
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.items" signature="IterativeAmplitudeEstimationResult.items() → a set-like object providing a view on D’s items" />
|
||
|
||
### keys
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.keys" signature="IterativeAmplitudeEstimationResult.keys() → a set-like object providing a view on D’s keys" />
|
||
|
||
### pop
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.pop" signature="IterativeAmplitudeEstimationResult.pop(key, default=None)">
|
||
If key is not found, d is returned if given, otherwise KeyError is raised.
|
||
|
||
**Return type**
|
||
|
||
`object`
|
||
</Function>
|
||
|
||
### popitem
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.popitem" signature="IterativeAmplitudeEstimationResult.popitem()">
|
||
as a 2-tuple; but raise KeyError if D is empty.
|
||
|
||
**Return type**
|
||
|
||
`Tuple`\[`object`, `object`]
|
||
</Function>
|
||
|
||
### setdefault
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.setdefault" signature="IterativeAmplitudeEstimationResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />
|
||
|
||
### update
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.update" signature="IterativeAmplitudeEstimationResult.update(*args, **kwargs)">
|
||
If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
### values
|
||
|
||
<Function id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.values" signature="IterativeAmplitudeEstimationResult.values() → an object providing a view on D’s values" />
|
||
|
||
## Attributes
|
||
|
||
### a\_estimation
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.a_estimation">
|
||
return a\_estimation
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### a\_intervals
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.a_intervals">
|
||
return a\_intervals
|
||
|
||
**Return type**
|
||
|
||
`List`\[`List`\[`float`]]
|
||
</Attribute>
|
||
|
||
### actual\_epsilon
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.actual_epsilon">
|
||
return mle
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### alpha
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.alpha">
|
||
return alpha
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### confidence\_interval
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.confidence_interval">
|
||
return confidence\_interval
|
||
|
||
**Return type**
|
||
|
||
`List`\[`float`]
|
||
</Attribute>
|
||
|
||
### estimation
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.estimation">
|
||
return estimation
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### num\_oracle\_queries
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.num_oracle_queries">
|
||
return num\_oracle\_queries
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### powers
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.powers">
|
||
return powers
|
||
|
||
**Return type**
|
||
|
||
`List`\[`int`]
|
||
</Attribute>
|
||
|
||
### ratios
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.ratios">
|
||
return ratios
|
||
|
||
**Return type**
|
||
|
||
`List`\[`float`]
|
||
</Attribute>
|
||
|
||
### theta\_intervals
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.theta_intervals">
|
||
return theta\_intervals
|
||
|
||
**Return type**
|
||
|
||
`List`\[`List`\[`float`]]
|
||
</Attribute>
|
||
|
||
### value\_confidence\_interval
|
||
|
||
<Attribute id="qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.value_confidence_interval">
|
||
return value\_confidence\_interval
|
||
|
||
**Return type**
|
||
|
||
`List`\[`float`]
|
||
</Attribute>
|
||
</Class>
|
||
|