Package ai.timefold.solver.core.impl.constructionheuristic

Class DefaultConstructionHeuristicPhase<Solution_>

java.lang.Object

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

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

ai.timefold.solver.core.impl.constructionheuristic.DefaultConstructionHeuristicPhase<Solution_>

Type Parameters:

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RuinRecreateConstructionHeuristicPhase

@NullMarked
public class DefaultConstructionHeuristicPhase<Solution_>
extends AbstractPossiblyInitializingPhase<Solution_>
implements ConstructionHeuristicPhase<Solution_>

Default implementation of ConstructionHeuristicPhase.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultConstructionHeuristicPhase.DefaultConstructionHeuristicPhaseBuilder<Solution_>

Nested classes/interfaces inherited from class ai.timefold.solver.core.impl.phase.AbstractPossiblyInitializingPhase

AbstractPossiblyInitializingPhase.AbstractPossiblyInitializingPhaseBuilder<Solution_>

Nested classes/interfaces inherited from class ai.timefold.solver.core.impl.phase.AbstractPhase

AbstractPhase.AbstractPhaseBuilder<Solution_>

Nested classes/interfaces inherited from interface ai.timefold.solver.core.impl.phase.PossiblyInitializingPhase

PossiblyInitializingPhase.TerminationStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConstructionHeuristicDecider<Solution_>	decider
protected final PlacerBasedMoveRepository<Solution_>	moveRepository

Fields inherited from class ai.timefold.solver.core.impl.phase.AbstractPhase

assertExpectedStepScore, assertPhaseScoreFromScratch, assertShadowVariablesAreNotStaleAfterStep, assertStepScoreFromScratch, logger, logIndentation, phaseIndex, phaseLifecycleSupport, phaseTermination

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultConstructionHeuristicPhase(DefaultConstructionHeuristicPhase.DefaultConstructionHeuristicPhaseBuilder<Solution_> builder)

Method Summary

Modifier and Type	Method	Description
protected ConstructionHeuristicPhaseScope<Solution_>	buildPhaseScope(SolverScope<Solution_> solverScope, int phaseIndex)
protected void	doStep(ConstructionHeuristicStepScope<Solution_> stepScope)
EntityPlacer<Solution_>	getEntityPlacer()
String	getPhaseTypeString()
PossiblyInitializingPhase.TerminationStatus	getTerminationStatus()	The status with which the phase terminated.
void	phaseEnded(ConstructionHeuristicPhaseScope<Solution_> phaseScope)
void	phaseStarted(ConstructionHeuristicPhaseScope<Solution_> phaseScope)
void	solve(SolverScope<Solution_> solverScope)
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingError(SolverScope<Solution_> solverScope, Exception exception)	Invoked in case of an exception in the Solver run.
void	solvingStarted(SolverScope<Solution_> solverScope)
void	stepEnded(ConstructionHeuristicStepScope<Solution_> stepScope)
void	stepStarted(ConstructionHeuristicStepScope<Solution_> stepScope)

Methods inherited from class ai.timefold.solver.core.impl.phase.AbstractPossiblyInitializingPhase

ensureCorrectTermination, isLastInitializingPhase, translateEarlyTermination

Methods inherited from class ai.timefold.solver.core.impl.phase.AbstractPhase

addPhaseLifecycleListener, assertWorkingSolutionInitialized, calculateWorkingStepScore, getPhaseIndex, getPhaseTermination, isAssertExpectedStepScore, isAssertShadowVariablesAreNotStaleAfterStep, isAssertStepScoreFromScratch, isNested, phaseEnded, phaseStarted, predictWorkingStepScore, removePhaseLifecycleListener, stepEnded, stepStarted

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

addPhaseLifecycleListener, removePhaseLifecycleListener

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.phase.PossiblyInitializingPhase

isLastInitializingPhase

Field Details

decider

protected final ConstructionHeuristicDecider<Solution_> decider

moveRepository

protected final PlacerBasedMoveRepository<Solution_> moveRepository

Constructor Details

DefaultConstructionHeuristicPhase

protected DefaultConstructionHeuristicPhase(DefaultConstructionHeuristicPhase.DefaultConstructionHeuristicPhaseBuilder<Solution_> builder)

Method Details

getEntityPlacer

public EntityPlacer<Solution_> getEntityPlacer()

getTerminationStatus

public PossiblyInitializingPhase.TerminationStatus getTerminationStatus()

Description copied from interface: PossiblyInitializingPhase

The status with which the phase terminated.

Specified by:

getTerminationStatus in interface PossiblyInitializingPhase<Solution_>

getPhaseTypeString

public String getPhaseTypeString()

Specified by:

getPhaseTypeString in class AbstractPhase<Solution_>

solve

public void solve(SolverScope<Solution_> solverScope)

Specified by:

solve in interface Phase<Solution_>

buildPhaseScope

protected ConstructionHeuristicPhaseScope<Solution_> buildPhaseScope(SolverScope<Solution_> solverScope,
 int phaseIndex)

doStep

protected void doStep(ConstructionHeuristicStepScope<Solution_> stepScope)

solvingStarted

public void solvingStarted(SolverScope<Solution_> solverScope)

Specified by:

solvingStarted in interface SolverLifecycleListener<Solution_>

Overrides:

solvingStarted in class AbstractPhase<Solution_>

phaseStarted

public void phaseStarted(ConstructionHeuristicPhaseScope<Solution_> phaseScope)

stepStarted

public void stepStarted(ConstructionHeuristicStepScope<Solution_> stepScope)

stepEnded

public void stepEnded(ConstructionHeuristicStepScope<Solution_> stepScope)

phaseEnded

public void phaseEnded(ConstructionHeuristicPhaseScope<Solution_> phaseScope)

solvingEnded

public void solvingEnded(SolverScope<Solution_> solverScope)

Specified by:

solvingEnded in interface SolverLifecycleListener<Solution_>

Overrides:

solvingEnded in class AbstractPhase<Solution_>

solvingError

public void solvingError(SolverScope<Solution_> solverScope,
 Exception exception)

Description copied from interface: SolverLifecycleListener

Invoked in case of an exception in the Solver run. In that case, the SolverLifecycleListener.solvingEnded(SolverScope) is never called. For internal purposes only.

Specified by:

solvingError in interface SolverLifecycleListener<Solution_>