gemseo_benchmark / results

Hide inherited members

history_item module

A performance history item.

class gemseo_benchmark.results.history_item.HistoryItem(objective_value, infeasibility_measure, n_unsatisfied_constraints=None)

Bases: object

A performance history item.

Parameters:

• objective_value (float) – The objective function value of the item.

• infeasibility_measure (float) – The infeasibility measure of the item.

• n_unsatisfied_constraints (int | None) – The number of unsatisfied constraints of the item. If None, it will be set to 0 if the infeasibility measure is zero, and if the infeasibility measure is positive it will be set to None.

apply_infeasibility_tolerance(infeasibility_tolerance)

Apply a tolerance on the infeasibility measure.

Mark the history item as feasible if its infeasibility measure is below the tolerance.

Parameters:

infeasibility_tolerance (float) – the tolerance on the infeasibility measure.

Return type:

None

property infeasibility_measure: float

The infeasibility measure of the history item.

Raises:

ValueError – If the infeasibility measure is negative.

property is_feasible: bool

Whether the history item is feasible.

property n_unsatisfied_constraints: int | None

The number of unsatisfied constraints.

property objective_value: float

The objective value of the history item.