Package ai.timefold.solver.core.impl.phase

Interface PossiblyInitializingPhase<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

All Superinterfaces:

EventListener, Phase<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>

All Known Subinterfaces:

ConstructionHeuristicPhase<Solution_>, CustomPhase<Solution_>

All Known Implementing Classes:

AbstractPossiblyInitializingPhase, DefaultConstructionHeuristicPhase, DefaultCustomPhase, RuinRecreateConstructionHeuristicPhase

@NullMarked
public interface PossiblyInitializingPhase<Solution_>
extends Phase<Solution_>

Describes a phase that can be used to initialize a solution. ConstructionHeuristicPhase is automatically an initializing phase. CustomPhase can be an initializing phase, if it comes before the first LocalSearchPhase.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	PossiblyInitializingPhase.TerminationStatus	The status with which the phase terminated.

Method Summary

Modifier and Type	Method	Description
PossiblyInitializingPhase.TerminationStatus	getTerminationStatus()	The status with which the phase terminated.
boolean	isLastInitializingPhase()	Check if a phase should trigger the first initialized solution event.

Methods inherited from interface ai.timefold.solver.core.impl.phase.Phase

addPhaseLifecycleListener, removePhaseLifecycleListener, solve

Methods inherited from interface ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener

solvingEnded, solvingError, solvingStarted

Method Details

isLastInitializingPhase

boolean isLastInitializingPhase()

Check if a phase should trigger the first initialized solution event. The first initialized solution immediately precedes the first LocalSearchPhase.

Returns:

true if the phase is the final phase before the first local search phase.

See Also:

• SolverJobBuilder.withFirstInitializedSolutionConsumer(FirstInitializedSolutionConsumer)

getTerminationStatus

PossiblyInitializingPhase.TerminationStatus getTerminationStatus()

The status with which the phase terminated.