87 lines
2.6 KiB
Plaintext
87 lines
2.6 KiB
Plaintext
---
|
||
title: VQDResult
|
||
description: API reference for qiskit.algorithms.eigensolvers.VQDResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.eigensolvers.VQDResult
|
||
---
|
||
|
||
# VQDResult
|
||
|
||
<Class id="qiskit.algorithms.eigensolvers.VQDResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py" signature="qiskit.algorithms.eigensolvers.VQDResult" modifiers="class">
|
||
Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult")
|
||
|
||
VQD Result.
|
||
|
||
## Attributes
|
||
|
||
### aux\_operators\_evaluated
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.aux_operators_evaluated">
|
||
Return the aux operator expectation values.
|
||
|
||
These values are in fact tuples formatted as (mean, metadata).
|
||
</Attribute>
|
||
|
||
### cost\_function\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.cost_function_evals">
|
||
Returns number of cost optimizer evaluations
|
||
</Attribute>
|
||
|
||
### eigenvalues
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.eigenvalues">
|
||
Return the eigenvalues.
|
||
</Attribute>
|
||
|
||
### optimal\_circuits
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.optimal_circuits">
|
||
The optimal circuits. Along with the optimal parameters, these can be used to retrieve the different eigenstates.
|
||
</Attribute>
|
||
|
||
### optimal\_parameters
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.optimal_parameters">
|
||
Returns the optimal parameters for each step
|
||
</Attribute>
|
||
|
||
### optimal\_points
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.optimal_points">
|
||
Returns optimal point for each step
|
||
</Attribute>
|
||
|
||
### optimal\_values
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.optimal_values">
|
||
Returns optimal value for each step
|
||
</Attribute>
|
||
|
||
### optimizer\_results
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.optimizer_results">
|
||
Returns the optimizer results for each step
|
||
</Attribute>
|
||
|
||
### optimizer\_times
|
||
|
||
<Attribute id="qiskit.algorithms.eigensolvers.VQDResult.optimizer_times">
|
||
Returns time taken for optimization for each step
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.eigensolvers.VQDResult.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>
|
||
|