95 lines
2.1 KiB
Plaintext
95 lines
2.1 KiB
Plaintext
---
|
||
title: OptimizerResult
|
||
description: API reference for qiskit.algorithms.optimizers.OptimizerResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.optimizers.OptimizerResult
|
||
---
|
||
|
||
# OptimizerResult
|
||
|
||
<Class id="qiskit.algorithms.optimizers.OptimizerResult" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/algorithms/optimizers/optimizer.py" signature="OptimizerResult" modifiers="class">
|
||
Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult`
|
||
|
||
The result of an optimization routine.
|
||
|
||
## Methods
|
||
|
||
### combine
|
||
|
||
<Function id="qiskit.algorithms.optimizers.OptimizerResult.combine" signature="OptimizerResult.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
|
||
|
||
### fun
|
||
|
||
<Attribute id="qiskit.algorithms.optimizers.OptimizerResult.fun">
|
||
The final value of the minimization.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`float`]
|
||
</Attribute>
|
||
|
||
### jac
|
||
|
||
<Attribute id="qiskit.algorithms.optimizers.OptimizerResult.jac">
|
||
The final gradient of the minimization.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`float`, `ndarray`, `None`]
|
||
</Attribute>
|
||
|
||
### nfev
|
||
|
||
<Attribute id="qiskit.algorithms.optimizers.OptimizerResult.nfev">
|
||
The total number of function evaluations.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### nit
|
||
|
||
<Attribute id="qiskit.algorithms.optimizers.OptimizerResult.nit">
|
||
The total number of iterations.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### njev
|
||
|
||
<Attribute id="qiskit.algorithms.optimizers.OptimizerResult.njev">
|
||
The total number of gradient evaluations.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### x
|
||
|
||
<Attribute id="qiskit.algorithms.optimizers.OptimizerResult.x">
|
||
The final point of the minimization.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`float`, `ndarray`, `None`]
|
||
</Attribute>
|
||
</Class>
|
||
|