74 lines
2.9 KiB
Plaintext
74 lines
2.9 KiB
Plaintext
---
|
||
title: EstimatorResult
|
||
description: API reference for qiskit.primitives.EstimatorResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.primitives.EstimatorResult
|
||
---
|
||
|
||
# EstimatorResult
|
||
|
||
<Class id="qiskit.primitives.EstimatorResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/primitives/base/estimator_result.py" signature="qiskit.primitives.EstimatorResult(values, metadata)" modifiers="class">
|
||
Bases: `_BasePrimitiveResult`
|
||
|
||
Result of Estimator.
|
||
|
||
```python
|
||
result = estimator.run(circuits, observables, params).result()
|
||
```
|
||
|
||
where the i-th elements of `result` correspond to the circuit and observable given by `circuits[i]`, `observables[i]`, and the parameter values bounds by `params[i]`. For example, `results.values[i]` gives the expectation value, and `result.metadata[i]` is a metadata dictionary for this circuit and parameters.
|
||
|
||
**Parameters**
|
||
|
||
* **values** (*np.ndarray*) – The array of the expectation values.
|
||
* **metadata** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*]*) – List of the metadata.
|
||
|
||
## Attributes
|
||
|
||
### experiments
|
||
|
||
<Attribute id="qiskit.primitives.EstimatorResult.experiments">
|
||
Experiment data dicts in any inheriting result dataclass.
|
||
|
||
<Admonition title="Deprecated since version 0.46.0" type="danger">
|
||
The property `qiskit.primitives.base.base_result._BasePrimitiveResult.experiments` is deprecated as of qiskit 0.46.0. It will be removed in the Qiskit 1.0 release.
|
||
</Admonition>
|
||
</Attribute>
|
||
|
||
### num\_experiments
|
||
|
||
<Attribute id="qiskit.primitives.EstimatorResult.num_experiments">
|
||
Number of experiments in any inheriting result dataclass.
|
||
|
||
<Admonition title="Deprecated since version 0.46.0" type="danger">
|
||
The property `qiskit.primitives.base.base_result._BasePrimitiveResult.num_experiments` is deprecated as of qiskit 0.46.0. It will be removed in the Qiskit 1.0 release.
|
||
</Admonition>
|
||
</Attribute>
|
||
|
||
### values
|
||
|
||
<Attribute id="qiskit.primitives.EstimatorResult.values" attributeTypeHint="np.ndarray[Any, np.dtype[np.float64]]" />
|
||
|
||
### metadata
|
||
|
||
<Attribute id="qiskit.primitives.EstimatorResult.metadata" attributeTypeHint="list[dict[str, Any]]" />
|
||
|
||
## Methods
|
||
|
||
### decompose
|
||
|
||
<Function id="qiskit.primitives.EstimatorResult.decompose" signature="decompose()">
|
||
Generate single experiment result objects from self.
|
||
|
||
<Admonition title="Deprecated since version 0.46.0" type="danger">
|
||
The method `qiskit.primitives.base.base_result._BasePrimitiveResult.decompose()` is deprecated as of qiskit 0.46.0. It will be removed in the Qiskit 1.0 release.
|
||
</Admonition>
|
||
|
||
**Return type**
|
||
|
||
[*Iterator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterator "(in Python v3.12)")\[*\_BasePrimitiveResult*]
|
||
</Function>
|
||
</Class>
|
||
|