qiskit.optimization.algorithms.ADMMOptimizationResult
class ADMMOptimizationResult(x, fval, variables, state, status)
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__
__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
Methods
__init__(x, fval, variables, state, status) | type xndarray |
Attributes
fval | Returns the optimal function value. |
raw_results | Return the original results object from the optimization algorithm. |
state | returns state |
status | Returns the termination status of the optimization algorithm. |
variable_names | Returns the list of variable names of the optimization problem. |
variables | Returns the list of variables of the optimization problem. |
variables_dict | Returns the optimal value as a dictionary of the variable name and corresponding value. |
x | Returns the optimal value found in the optimization or None in case of FAILURE. |
fval
Returns the optimal function value.
Return type
float
Returns
The function value corresponding to the optimal value found in the optimization.
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.
state
returns state
Return type
ADMMState
status
Returns the termination status of the optimization algorithm.
Return type
OptimizationResultStatus
Returns
The termination status of the algorithm.
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.
variables
Returns the list of variables of the optimization problem.
Return type
List[Variable]
Returns
The list of variables.
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.
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.