gemseo / algos

opt_result module

Classes:

OptimizationResult([x_0, x_opt, f_opt, ...])

Stores optimization results.

class gemseo.algos.opt_result.OptimizationResult(x_0=None, x_opt=None, f_opt=None, status=None, constraints_values=None, constraints_grad=None, optimizer_name=None, message=None, n_obj_call=None, n_grad_call=None, n_constr_call=None, is_feasible=False)

Bases: object

Stores optimization results.

Initialize optimization results.

Parameters

• x_0 –

  initial guess for design variables

  By default it is set to None.

• x_opt –

  optimal design variables values

  By default it is set to None.

• f_opt –

  the objective function values at optimum

  By default it is set to None.

• status –

  the optimizer status

  By default it is set to None.

• message –

  the optimizer message

  By default it is set to None.

• n_obj_call –

  number of call to objective function by optimizer

  By default it is set to None.

• n_grad_call –

  number of call to gradient function by optimizer

  By default it is set to None.

• n_constr_call –

  number of call to constraints function by optimizer

  By default it is set to None.

• is_feasible –

  True if the solution is feasible, false else

  By default it is set to False.

Attributes:

DICT_REPR_ATTR
HDF_CSTR_GRAD_KEY
HDF_CSTR_KEY

Methods:

get_data_dict_repr()	Returns a dict representation of self for serialization functions are removed.
init_from_dict_repr(**kwargs)	Initializes a new opt result from a data dict typically used for deserialization.

DICT_REPR_ATTR = ['x_0', 'x_opt', 'optimizer_name', 'message', 'f_opt', 'status', 'n_obj_call', 'n_grad_call', 'n_constr_call', 'is_feasible']

HDF_CSTR_GRAD_KEY = 'constr_grad:'

HDF_CSTR_KEY = 'constr:'

get_data_dict_repr()

Returns a dict representation of self for serialization functions are removed.

Returns

a dict with attributes names as keys

static init_from_dict_repr(**kwargs)

Initializes a new opt result from a data dict typically used for deserialization.

Parameters

kwargs – key value pairs from DICT_REPR_ATTR