109 lines
3.7 KiB
Plaintext
109 lines
3.7 KiB
Plaintext
---
|
||
title: SamplingVQEResult
|
||
description: API reference for qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult
|
||
---
|
||
|
||
# SamplingVQEResult
|
||
|
||
<Class id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py" signature="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult" modifiers="class">
|
||
Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult")
|
||
|
||
VQE Result.
|
||
|
||
## Attributes
|
||
|
||
### aux\_operators\_evaluated
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.aux_operators_evaluated">
|
||
Return aux operator expectation values and metadata.
|
||
|
||
These are formatted as (mean, metadata).
|
||
</Attribute>
|
||
|
||
### best\_measurement
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.best_measurement">
|
||
Return the best measurement over the entire optimization.
|
||
|
||
Possesses keys: `state`, `bitstring`, `value`, `probability`.
|
||
</Attribute>
|
||
|
||
### cost\_function\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.cost_function_evals">
|
||
Returns number of cost optimizer evaluations
|
||
</Attribute>
|
||
|
||
### eigenstate
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.eigenstate">
|
||
Return the quasi-distribution sampled from the final state.
|
||
|
||
The ansatz is sampled when parameterized with the optimal parameters that where obtained computing the minimum eigenvalue. The keys represent a measured classical value and the value is a float for the quasi-probability of that result.
|
||
</Attribute>
|
||
|
||
### eigenvalue
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.eigenvalue">
|
||
Return the approximation to the eigenvalue.
|
||
</Attribute>
|
||
|
||
### optimal\_circuit
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimal_circuit">
|
||
The optimal circuits. Along with the optimal parameters, these can be used to retrieve the minimum eigenstate.
|
||
</Attribute>
|
||
|
||
### optimal\_parameters
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimal_parameters">
|
||
Returns the optimal parameters in a dictionary
|
||
</Attribute>
|
||
|
||
### optimal\_point
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimal_point">
|
||
Returns optimal point
|
||
</Attribute>
|
||
|
||
### optimal\_value
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimal_value">
|
||
Returns optimal value
|
||
</Attribute>
|
||
|
||
### optimizer\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimizer_evals">
|
||
Returns number of optimizer evaluations
|
||
</Attribute>
|
||
|
||
### optimizer\_result
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimizer_result">
|
||
Returns the optimizer result
|
||
</Attribute>
|
||
|
||
### optimizer\_time
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.optimizer_time">
|
||
Returns time taken for optimization
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.combine" signature="combine(result)">
|
||
Any property from the argument that exists in the receiver is updated. :param result: Argument result with properties to be set.
|
||
|
||
**Raises**
|
||
|
||
[**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.12)") – Argument is None
|
||
</Function>
|
||
</Class>
|
||
|