SlsqpOptimizationResult#

class SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)[source]#

Bases: OptimizationResult

SLSQP optimization result, defines additional properties that may be returned by the optimizer.

Constructs a result object with properties specific to SLSQP.

Parameters:

  • x (List[float] | ndarray) – The solution of the problem

  • fval (float) – The value of the objective function of the solution

  • variables (List[Variable]) – A list of variables defined in the problem

  • fx (ndarray | None) – The value of the objective function being optimized, may be different from fval

  • its (int | None) – The number of iterations.

  • imode (int | None) – The exit mode from the optimizer (see the documentation of scipy.optimize.fmin_slsqp).

  • smode (str | None) – Message describing the exit mode from the optimizer.

  • status (OptimizationResultStatus) – the termination status of the optimization algorithm.

Attributes

fval#

Returns the objective function value.

Returns:

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

fx#

Returns the final value of the objective function being actually optimized.

imode#

Returns the exit mode from the optimizer.

its#

Returns the number of iterations

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.

smode#

Returns message describing the exit mode from the optimizer.

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:

ndarray

prettyprint()#

Returns a pretty printed string of this optimization result.

Returns:

A pretty printed string representing the result.

Return type:

str