209 lines
9.7 KiB
Plaintext
209 lines
9.7 KiB
Plaintext
---
|
||
title: SlsqpOptimizationResult
|
||
description: API reference for qiskit.optimization.algorithms.SlsqpOptimizationResult
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult
|
||
---
|
||
|
||
<span id="qiskit-optimization-algorithms-slsqpoptimizationresult" />
|
||
|
||
# qiskit.optimization.algorithms.SlsqpOptimizationResult
|
||
|
||
<Class id="qiskit.optimization.algorithms.SlsqpOptimizationResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/algorithms/slsqp_optimizer.py" signature="SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)" modifiers="class">
|
||
SLSQP optimization result, defines additional properties that may be returned by the optimizer.
|
||
|
||
Constructs a result object with properties specific to SLSQP.
|
||
|
||
**Parameters**
|
||
|
||
* **x** (`Union`\[`List`\[`float`], `ndarray`]) – The solution of the problem
|
||
* **fval** (`float`) – The value of the objective function of the solution
|
||
* **variables** (`List`\[`Variable`]) – A list of variables defined in the problem
|
||
* **fx** (`Optional`\[`ndarray`]) – The value of the objective function being optimized, may be different from `fval`
|
||
* **its** (`Optional`\[`int`]) – The number of iterations.
|
||
* **imode** (`Optional`\[`int`]) – The exit mode from the optimizer (see the documentation of `scipy.optimize.fmin_slsqp`).
|
||
* **smode** (`Optional`\[`str`]) – Message describing the exit mode from the optimizer.
|
||
* **status** (`OptimizationResultStatus`) – the termination status of the optimization algorithm.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.optimization.algorithms.SlsqpOptimizationResult.__init__" signature="__init__(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)">
|
||
Constructs a result object with properties specific to SLSQP.
|
||
|
||
**Parameters**
|
||
|
||
* **x** (`Union`\[`List`\[`float`], `ndarray`]) – The solution of the problem
|
||
* **fval** (`float`) – The value of the objective function of the solution
|
||
* **variables** (`List`\[`Variable`]) – A list of variables defined in the problem
|
||
* **fx** (`Optional`\[`ndarray`]) – The value of the objective function being optimized, may be different from `fval`
|
||
* **its** (`Optional`\[`int`]) – The number of iterations.
|
||
* **imode** (`Optional`\[`int`]) – The exit mode from the optimizer (see the documentation of `scipy.optimize.fmin_slsqp`).
|
||
* **smode** (`Optional`\[`str`]) – Message describing the exit mode from the optimizer.
|
||
* **status** (`OptimizationResultStatus`) – the termination status of the optimization algorithm.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.__init__ "qiskit.optimization.algorithms.SlsqpOptimizationResult.__init__")(x, fval, variables, status\[, fx, …]) | Constructs a result object with properties specific to SLSQP. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
|
||
| [`fval`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.fval "qiskit.optimization.algorithms.SlsqpOptimizationResult.fval") | Returns the optimal function value. |
|
||
| [`fx`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.fx "qiskit.optimization.algorithms.SlsqpOptimizationResult.fx") | Returns the final value of the objective function being actually optimized. |
|
||
| [`imode`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.imode "qiskit.optimization.algorithms.SlsqpOptimizationResult.imode") | Returns the exit mode from the optimizer. |
|
||
| [`its`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.its "qiskit.optimization.algorithms.SlsqpOptimizationResult.its") | Returns the number of iterations |
|
||
| [`raw_results`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.raw_results "qiskit.optimization.algorithms.SlsqpOptimizationResult.raw_results") | Return the original results object from the optimization algorithm. |
|
||
| [`smode`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.smode "qiskit.optimization.algorithms.SlsqpOptimizationResult.smode") | Returns message describing the exit mode from the optimizer. |
|
||
| [`status`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.status "qiskit.optimization.algorithms.SlsqpOptimizationResult.status") | Returns the termination status of the optimization algorithm. |
|
||
| [`variable_names`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.variable_names "qiskit.optimization.algorithms.SlsqpOptimizationResult.variable_names") | Returns the list of variable names of the optimization problem. |
|
||
| [`variables`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.variables "qiskit.optimization.algorithms.SlsqpOptimizationResult.variables") | Returns the list of variables of the optimization problem. |
|
||
| [`variables_dict`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.variables_dict "qiskit.optimization.algorithms.SlsqpOptimizationResult.variables_dict") | Returns the optimal value as a dictionary of the variable name and corresponding value. |
|
||
| [`x`](#qiskit.optimization.algorithms.SlsqpOptimizationResult.x "qiskit.optimization.algorithms.SlsqpOptimizationResult.x") | Returns the optimal value found in the optimization or None in case of FAILURE. |
|
||
|
||
### fval
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.fval">
|
||
Returns the optimal function value.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
|
||
**Returns**
|
||
|
||
The function value corresponding to the optimal value found in the optimization.
|
||
</Attribute>
|
||
|
||
### fx
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.fx">
|
||
Returns the final value of the objective function being actually optimized.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
</Attribute>
|
||
|
||
### imode
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.imode">
|
||
Returns the exit mode from the optimizer.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### its
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.its">
|
||
Returns the number of iterations
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`int`]
|
||
</Attribute>
|
||
|
||
### raw\_results
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.raw_results">
|
||
Return the original results object from the optimization algorithm.
|
||
|
||
Currently a dump for any leftovers.
|
||
|
||
**Return type**
|
||
|
||
`Any`
|
||
|
||
**Returns**
|
||
|
||
Additional result information of the optimization algorithm.
|
||
</Attribute>
|
||
|
||
### smode
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.smode">
|
||
Returns message describing the exit mode from the optimizer.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`str`]
|
||
</Attribute>
|
||
|
||
### status
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.status">
|
||
Returns the termination status of the optimization algorithm.
|
||
|
||
**Return type**
|
||
|
||
`OptimizationResultStatus`
|
||
|
||
**Returns**
|
||
|
||
The termination status of the algorithm.
|
||
</Attribute>
|
||
|
||
### variable\_names
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.variable_names">
|
||
Returns the list of variable names of the optimization problem.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`str`]
|
||
|
||
**Returns**
|
||
|
||
The list of variable names of the optimization problem.
|
||
</Attribute>
|
||
|
||
### variables
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.variables">
|
||
Returns the list of variables of the optimization problem.
|
||
|
||
**Return type**
|
||
|
||
`List`\[`Variable`]
|
||
|
||
**Returns**
|
||
|
||
The list of variables.
|
||
</Attribute>
|
||
|
||
### variables\_dict
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.variables_dict">
|
||
Returns the optimal value as a dictionary of the variable name and corresponding value.
|
||
|
||
**Return type**
|
||
|
||
`Dict`\[`str`, `float`]
|
||
|
||
**Returns**
|
||
|
||
The optimal value as a dictionary of the variable name and corresponding value.
|
||
</Attribute>
|
||
|
||
### x
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.SlsqpOptimizationResult.x">
|
||
Returns the optimal value found in the optimization or None in case of FAILURE.
|
||
|
||
**Return type**
|
||
|
||
`Optional`\[`ndarray`]
|
||
|
||
**Returns**
|
||
|
||
The optimal value found in the optimization.
|
||
</Attribute>
|
||
</Class>
|
||
|