181 lines
7.6 KiB
Plaintext
181 lines
7.6 KiB
Plaintext
---
|
||
title: ADMMOptimizationResult (v0.26)
|
||
description: API reference for qiskit.optimization.algorithms.ADMMOptimizationResult in qiskit v0.26
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult
|
||
---
|
||
|
||
<span id="qiskit-optimization-algorithms-admmoptimizationresult" />
|
||
|
||
# qiskit.optimization.algorithms.ADMMOptimizationResult
|
||
|
||
<Class id="qiskit.optimization.algorithms.ADMMOptimizationResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/algorithms/admm_optimizer.py" signature="ADMMOptimizationResult(x, fval, variables, state, status)" modifiers="class">
|
||
ADMMOptimization Result.
|
||
|
||
**Parameters**
|
||
|
||
* **x** (`ndarray`) – the optimal value found by ADMM.
|
||
* **fval** (`float`) – the optimal function value.
|
||
* **variables** (`List`\[`Variable`]) – the list of variables of the optimization problem.
|
||
* **state** (`ADMMState`) – the internal computation state of ADMM.
|
||
* **status** (`OptimizationResultStatus`) – Termination status of an optimization algorithm
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.optimization.algorithms.ADMMOptimizationResult.__init__" signature="__init__(x, fval, variables, state, status)">
|
||
**Parameters**
|
||
|
||
* **x** (`ndarray`) – the optimal value found by ADMM.
|
||
* **fval** (`float`) – the optimal function value.
|
||
* **variables** (`List`\[`Variable`]) – the list of variables of the optimization problem.
|
||
* **state** (`ADMMState`) – the internal computation state of ADMM.
|
||
* **status** (`OptimizationResultStatus`) – Termination status of an optimization algorithm
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
|
||
| [`__init__`](#qiskit.optimization.algorithms.ADMMOptimizationResult.__init__ "qiskit.optimization.algorithms.ADMMOptimizationResult.__init__")(x, fval, variables, state, status) | **type x**`ndarray` |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||
| [`fval`](#qiskit.optimization.algorithms.ADMMOptimizationResult.fval "qiskit.optimization.algorithms.ADMMOptimizationResult.fval") | Returns the optimal function value. |
|
||
| [`raw_results`](#qiskit.optimization.algorithms.ADMMOptimizationResult.raw_results "qiskit.optimization.algorithms.ADMMOptimizationResult.raw_results") | Return the original results object from the optimization algorithm. |
|
||
| [`samples`](#qiskit.optimization.algorithms.ADMMOptimizationResult.samples "qiskit.optimization.algorithms.ADMMOptimizationResult.samples") | Returns the list of solution samples |
|
||
| [`state`](#qiskit.optimization.algorithms.ADMMOptimizationResult.state "qiskit.optimization.algorithms.ADMMOptimizationResult.state") | returns state |
|
||
| [`status`](#qiskit.optimization.algorithms.ADMMOptimizationResult.status "qiskit.optimization.algorithms.ADMMOptimizationResult.status") | Returns the termination status of the optimization algorithm. |
|
||
| [`variable_names`](#qiskit.optimization.algorithms.ADMMOptimizationResult.variable_names "qiskit.optimization.algorithms.ADMMOptimizationResult.variable_names") | Returns the list of variable names of the optimization problem. |
|
||
| [`variables`](#qiskit.optimization.algorithms.ADMMOptimizationResult.variables "qiskit.optimization.algorithms.ADMMOptimizationResult.variables") | Returns the list of variables of the optimization problem. |
|
||
| [`variables_dict`](#qiskit.optimization.algorithms.ADMMOptimizationResult.variables_dict "qiskit.optimization.algorithms.ADMMOptimizationResult.variables_dict") | Returns the optimal value as a dictionary of the variable name and corresponding value. |
|
||
| [`x`](#qiskit.optimization.algorithms.ADMMOptimizationResult.x "qiskit.optimization.algorithms.ADMMOptimizationResult.x") | Returns the optimal value found in the optimization or None in case of FAILURE. |
|
||
|
||
### fval
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.ADMMOptimizationResult.fval">
|
||
Returns the optimal function value.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
|
||
**Returns**
|
||
|
||
The function value corresponding to the optimal value found in the optimization.
|
||
</Attribute>
|
||
|
||
### raw\_results
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.ADMMOptimizationResult.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>
|
||
|
||
### samples
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.ADMMOptimizationResult.samples">
|
||
Returns the list of solution samples
|
||
|
||
**Return type**
|
||
|
||
`List`\[`SolutionSample`]
|
||
|
||
**Returns**
|
||
|
||
The list of solution samples.
|
||
</Attribute>
|
||
|
||
### state
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.ADMMOptimizationResult.state">
|
||
returns state
|
||
|
||
**Return type**
|
||
|
||
`ADMMState`
|
||
</Attribute>
|
||
|
||
### status
|
||
|
||
<Attribute id="qiskit.optimization.algorithms.ADMMOptimizationResult.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.ADMMOptimizationResult.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.ADMMOptimizationResult.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.ADMMOptimizationResult.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.ADMMOptimizationResult.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>
|
||
|