149 lines
3.8 KiB
Plaintext
149 lines
3.8 KiB
Plaintext
---
|
||
title: VQDResult
|
||
description: API reference for qiskit.algorithms.VQDResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.VQDResult
|
||
---
|
||
|
||
# VQDResult
|
||
|
||
<Class id="qiskit.algorithms.VQDResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py" signature="VQDResult" modifiers="class">
|
||
Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult")
|
||
|
||
Pending deprecation: VQD Result.
|
||
|
||
The VQDResult class has been superseded by the [`qiskit.algorithms.eigensolvers.VQDResult`](qiskit.algorithms.eigensolvers.VQDResult "qiskit.algorithms.eigensolvers.VQDResult") class. This class will be deprecated in a future release and subsequently removed after that.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.VQDResult.combine" signature="VQDResult.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>
|
||
|
||
## Attributes
|
||
|
||
### aux\_operator\_eigenvalues
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.aux_operator_eigenvalues">
|
||
Return aux operator expectation values.
|
||
|
||
These values are in fact tuples formatted as (mean, standard deviation).
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`List`\[`Union`\[`List`\[`Optional`\[`Tuple`\[`complex`, `complex`]]], `Dict`\[`str`, `Tuple`\[`complex`, `complex`]]]]]
|
||
</Attribute>
|
||
|
||
### cost\_function\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.cost_function_evals">
|
||
Returns number of cost optimizer evaluations
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### eigenstates
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.eigenstates">
|
||
return eigen state
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### eigenvalues
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.eigenvalues">
|
||
returns eigen values
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### optimal\_circuit
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimal_circuit">
|
||
The optimal circuits. Along with the optimal parameters, these can be used to retrieve the minimum eigenstate.
|
||
|
||
**Return type**
|
||
|
||
[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||
</Attribute>
|
||
|
||
### optimal\_parameters
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimal_parameters">
|
||
Returns the optimal parameters in a dictionary
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`Dict`]
|
||
</Attribute>
|
||
|
||
### optimal\_point
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimal_point">
|
||
Returns optimal point
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### optimal\_value
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimal_value">
|
||
Returns optimal value
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`float`]
|
||
</Attribute>
|
||
|
||
### optimizer\_evals
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimizer_evals">
|
||
Returns number of optimizer evaluations
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### optimizer\_result
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimizer_result">
|
||
Returns the optimizer result
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[[`OptimizerResult`](qiskit.algorithms.optimizers.OptimizerResult "qiskit.algorithms.optimizers.optimizer.OptimizerResult")]
|
||
</Attribute>
|
||
|
||
### optimizer\_time
|
||
|
||
<Attribute id="qiskit.algorithms.VQDResult.optimizer_time">
|
||
Returns time taken for optimization
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`float`]
|
||
</Attribute>
|
||
</Class>
|
||
|