119 lines
3.7 KiB
Plaintext
119 lines
3.7 KiB
Plaintext
---
|
||
title: AdaptVQEResult
|
||
description: API reference for qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult
|
||
---
|
||
|
||
# AdaptVQEResult
|
||
|
||
<Class id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py" signature="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult" modifiers="class">
|
||
Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult")
|
||
|
||
AdaptVQE Result.
|
||
|
||
## Attributes
|
||
|
||
### aux\_operators\_evaluated
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.aux_operators_evaluated">
|
||
The aux operator expectation values.
|
||
|
||
These values are in fact tuples formatted as (mean, (variance, shots)).
|
||
</Attribute>
|
||
|
||
### cost\_function\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.cost_function_evals">
|
||
The number of cost optimizer evaluations.
|
||
</Attribute>
|
||
|
||
### eigenvalue
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.eigenvalue">
|
||
The computed minimum eigenvalue.
|
||
</Attribute>
|
||
|
||
### eigenvalue\_history
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.eigenvalue_history">
|
||
Returns the history of computed eigenvalues.
|
||
|
||
The history’s length matches the number of iterations and includes the final computed value.
|
||
</Attribute>
|
||
|
||
### final\_max\_gradient
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.final_max_gradient">
|
||
Returns the final maximum gradient.
|
||
</Attribute>
|
||
|
||
### num\_iterations
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.num_iterations">
|
||
Returns the number of iterations.
|
||
</Attribute>
|
||
|
||
### optimal\_circuit
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.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.AdaptVQEResult.optimal_parameters">
|
||
Returns the optimal parameters in a dictionary
|
||
</Attribute>
|
||
|
||
### optimal\_point
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.optimal_point">
|
||
Returns optimal point
|
||
</Attribute>
|
||
|
||
### optimal\_value
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.optimal_value">
|
||
Returns optimal value
|
||
</Attribute>
|
||
|
||
### optimizer\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.optimizer_evals">
|
||
Returns number of optimizer evaluations
|
||
</Attribute>
|
||
|
||
### optimizer\_result
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.optimizer_result">
|
||
Returns the optimizer result
|
||
</Attribute>
|
||
|
||
### optimizer\_time
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.optimizer_time">
|
||
Returns time taken for optimization
|
||
</Attribute>
|
||
|
||
### termination\_criterion
|
||
|
||
<Attribute id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.termination_criterion">
|
||
Returns the termination criterion.
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.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>
|
||
|