qiskit.optimization.algorithms.ADMMOptimizationResult¶

class ADMMOptimizationResult(x, fval, variables, state, status)[source]¶

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__(x, fval, variables, state, status)[source]¶

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)

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.

property fval¶

Returns the optimal function value.

Return type: float
Returns: The function value corresponding to the optimal value found in the optimization.

property raw_results¶

Return the original results object from the optimization algorithm.

Currently a dump for any leftovers.

property state¶

returns state

property status¶

Returns the termination status of the optimization algorithm.

property variable_names¶

Returns the list of variable names of the optimization problem.

property variables¶

Returns the list of variables of the optimization problem.

property 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.

property x¶

Returns the optimal value found in the optimization or None in case of FAILURE.