ADMMOptimizationResult¶

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

ADMMOptimization Result.

Parameters:

x (np.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

Attributes

fval¶

Returns the objective function value.

Returns:: The function value corresponding to the objective function value found in the optimization.

raw_results¶

Return the original results object from the optimization algorithm.

Currently a dump for any leftovers.

samples¶

Returns the list of solution samples

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 variable values as a dictionary of the variable name and corresponding value.

Returns:: The variable values as a dictionary of the variable name and corresponding value.

Returns the variable values found in the optimization or None in case of FAILURE.

Methods

get_correlations()¶

Get <Zi x Zj> correlation matrix from the samples.

prettyprint()¶

Returns a pretty printed string of this optimization result.