ADMMOptimizationResult#
- class ADMMOptimizationResult(x, fval, variables, state, status)[source]#
Bases:
OptimizationResultADMMOptimization 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
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.
- Returns:
Additional result information of the optimization algorithm.
- samples#
Returns the list of solution samples
- Returns:
The list of solution samples.
- state#
returns state
- status#
Returns the termination status of the optimization algorithm.
- Returns:
The termination status of the algorithm.
- variable_names#
Returns the list of variable names of the optimization problem.
- Returns:
The list of variable names of the optimization problem.
- variables#
Returns the list of variables of the optimization problem.
- Returns:
The list of variables.
- 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.
- x#
Returns the variable values found in the optimization or None in case of FAILURE.
- Returns:
The variable values found in the optimization.
Methods
- get_correlations()#
Get <Zi x Zj> correlation matrix from the samples.
- Returns:
A correlation matrix.
- Return type: