HxCallbackType Enumeration¶

class hexaly.optimizer.HxCallbackType¶

List of types that can be used with callbacks. Each type corresponds to a specific event that can occur during the resolution.

As other enumerations present in the hexaly.optimizer module, HxCallbackType is enumerable and indexable:

print (HxCallbackType[0])                    # Shows HxCallbackType.PHASE_STARTED
print (HxCallbackType.PHASE_STARTED.value)   # Shows 0

# Iterates over the members of HxCallbackType
for e in HxCallbackType:
    print e

Since:

4.0

See:

HexalyOptimizer.add_callback()

PHASE_STARTED¶

Event that occurs when a phase is started.

PHASE_ENDED¶

Event that occurs when a phase ends.

DISPLAY¶

Event that occurs regularly before, after and during the search to display useful information about the model and the resolution. The time between two such events can be tuned with the HxParam.time_between_displays parameter.

TIME_TICKED¶

Event that occurs regularly during the resolution. The time between two such events can be tuned with the HxParam.time_between_ticks parameter.

Since:

6.0

ITERATION_TICKED¶

Event that occurs regularly during the resolution. The number of iterations between two such events can be tuned with the HxParam.iteration_between_ticks parameter.

Since:

6.0