Optimisation Result

class pbparam.OptimisationResult(x, success, message, fun, raw_result, optimisation_problem, optimiser_name)

Optimisation result class

Parameters:

• x (array-like) – The solution of the optimisation.

• success (bool) – Whether or not the optimiser exited successfully.

• message (str) – Description of the cause of the termination.

• fun (float) – Value of the objective function.

• raw_result (scipy.optimize.OptimizeResult) – The raw result of the optimisation.

• optimisation_problem (object) – The optimisation problem that was used for the optimization.

• optimiser_name (str) – The optimiser name used in the optimisation.

plot(testing=False)

Plot the optimisation result.

Parameters:

testing (bool, optional) – If True, the plot is not shown. The default is False.

Returns:

plot – The plot object.

Return type:

object