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

Class AbstractPhase<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.phase.AbstractPhase<Solution_>

Type Parameters:

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPossiblyInitializingPhase, DefaultExhaustiveSearchPhase, DefaultLocalSearchPhase, NoChangePhase

public abstract class AbstractPhase<Solution_>
extends Object
implements Phase<Solution_>

See Also:

• DefaultLocalSearchPhase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractPhase.AbstractPhaseBuilder<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	assertExpectedStepScore
protected final boolean	assertPhaseScoreFromScratch
protected final boolean	assertShadowVariablesAreNotStaleAfterStep
protected final boolean	assertStepScoreFromScratch
protected final org.slf4j.Logger	logger
protected final String	logIndentation
protected final int	phaseIndex
protected PhaseLifecycleSupport<Solution_>	phaseLifecycleSupport	Used for addPhaseLifecycleListener(PhaseLifecycleListener).
protected final PhaseTermination<Solution_>	phaseTermination

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPhase(AbstractPhase.AbstractPhaseBuilder<Solution_> builder)

Method Summary

Modifier and Type	Method	Description
void	addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)	Add a PhaseLifecycleListener that is only notified of the phase and the step starting/ending events from this phase (and the solving events too of course).
protected void	assertWorkingSolutionInitialized(AbstractPhaseScope<Solution_> phaseScope)
protected void	calculateWorkingStepScore(AbstractStepScope<Solution_> stepScope, Object completedAction)
int	getPhaseIndex()
Termination<Solution_>	getPhaseTermination()
abstract String	getPhaseTypeString()
boolean	isAssertExpectedStepScore()
boolean	isAssertShadowVariablesAreNotStaleAfterStep()
boolean	isAssertStepScoreFromScratch()
protected boolean	isNested()	Whether this phase is nested inside another phase.
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
protected <Score_ extends Score<Score_>> void	predictWorkingStepScore(AbstractStepScope<Solution_> stepScope, Object completedAction)
void	removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingStarted(SolverScope<Solution_> solverScope)
void	stepEnded(AbstractStepScope<Solution_> stepScope)
void	stepStarted(AbstractStepScope<Solution_> stepScope)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

solve

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

solvingError

Field Details

logger

protected final transient org.slf4j.Logger logger

phaseIndex

protected final int phaseIndex

logIndentation

protected final String logIndentation

phaseTermination

protected final PhaseTermination<Solution_> phaseTermination

assertPhaseScoreFromScratch

protected final boolean assertPhaseScoreFromScratch

assertStepScoreFromScratch

protected final boolean assertStepScoreFromScratch

assertExpectedStepScore

protected final boolean assertExpectedStepScore

assertShadowVariablesAreNotStaleAfterStep

protected final boolean assertShadowVariablesAreNotStaleAfterStep

phaseLifecycleSupport

protected PhaseLifecycleSupport<Solution_> phaseLifecycleSupport

Used for addPhaseLifecycleListener(PhaseLifecycleListener).

Constructor Details

AbstractPhase

protected AbstractPhase(AbstractPhase.AbstractPhaseBuilder<Solution_> builder)

Method Details

getPhaseIndex

public int getPhaseIndex()

getPhaseTermination

public Termination<Solution_> getPhaseTermination()

isAssertStepScoreFromScratch

public boolean isAssertStepScoreFromScratch()

isAssertExpectedStepScore

public boolean isAssertExpectedStepScore()

isAssertShadowVariablesAreNotStaleAfterStep

public boolean isAssertShadowVariablesAreNotStaleAfterStep()

getPhaseTypeString

public abstract String getPhaseTypeString()

solvingStarted

public void solvingStarted(SolverScope<Solution_> solverScope)

Specified by:

solvingStarted in interface SolverLifecycleListener<Solution_>

solvingEnded

public void solvingEnded(SolverScope<Solution_> solverScope)

Specified by:

solvingEnded in interface SolverLifecycleListener<Solution_>

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

isNested

protected boolean isNested()

Whether this phase is nested inside another phase. Nested phases, such as ruin and recreate, must not notify the solver of their starting; otherwise unimproved termination of local search would be reset every time the nested phase starts, effectively disabling this termination. Nested phases also do not collect step and phase metrics.

Returns:

false for nested phases, true for every other phase

phaseEnded

public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener<Solution_>

stepStarted

public void stepStarted(AbstractStepScope<Solution_> stepScope)

Specified by:

stepStarted in interface PhaseLifecycleListener<Solution_>

calculateWorkingStepScore

protected void calculateWorkingStepScore(AbstractStepScope<Solution_> stepScope,
 Object completedAction)

predictWorkingStepScore

protected <Score_ extends Score<Score_>> void predictWorkingStepScore(AbstractStepScope<Solution_> stepScope,
 Object completedAction)

stepEnded

public void stepEnded(AbstractStepScope<Solution_> stepScope)

Specified by:

stepEnded in interface PhaseLifecycleListener<Solution_>

addPhaseLifecycleListener

public void addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Description copied from interface: Phase

Add a PhaseLifecycleListener that is only notified of the phase and the step starting/ending events from this phase (and the solving events too of course).

To get notified for all phases, use AbstractSolver.addPhaseLifecycleListener(PhaseLifecycleListener) instead.

Specified by:

addPhaseLifecycleListener in interface Phase<Solution_>

Parameters:

phaseLifecycleListener - never null

removePhaseLifecycleListener

public void removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Specified by:

removePhaseLifecycleListener in interface Phase<Solution_>

Parameters:

phaseLifecycleListener - never null

See Also:

• Phase.addPhaseLifecycleListener(PhaseLifecycleListener)

assertWorkingSolutionInitialized

protected void assertWorkingSolutionInitialized(AbstractPhaseScope<Solution_> phaseScope)