English
Languages
English
Shortcuts



SlsqpOptimizationResult

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

Bases: qiskit_optimization.algorithms.optimization_algorithm.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 (Union[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 (Optional[ndarray]) – The value of the objective function being optimized, may be different from fval

  • its (Optional[int]) – The number of iterations.

  • imode (Optional[int]) – The exit mode from the optimizer (see the documentation of scipy.optimize.fmin_slsqp).

  • smode (Optional[str]) – Message describing the exit mode from the optimizer.

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

Attributes

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

smode

Returns message describing the exit mode from the optimizer.

Methods