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

Class AbstractSolver<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.solver.AbstractSolver<Solution_>

Type Parameters:

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

All Implemented Interfaces:

Solver<Solution_>

Direct Known Subclasses:

DefaultSolver

public abstract class AbstractSolver<Solution_>
extends Object
implements Solver<Solution_>

Common code between DefaultSolver and child solvers.

Do not create a new child Solver to implement a new heuristic or metaheuristic, just use a new Phase for that.

See Also:

• Solver
• DefaultSolver

Field Summary

Fields

Modifier and Type	Field	Description
protected final BestSolutionRecaller<Solution_>	bestSolutionRecaller
protected final UniversalTermination<Solution_>	globalTermination
protected final org.slf4j.Logger	logger
protected final List<Phase<Solution_>>	phaseList

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSolver(BestSolutionRecaller<Solution_> bestSolutionRecaller, UniversalTermination<Solution_> globalTermination, List<Phase<Solution_>> phaseList)

Method Summary

Modifier and Type	Method	Description
void	addEventListener(SolverEventListener<Solution_> eventListener)
void	addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)	Add a PhaseLifecycleListener that is notified of solving events and also of the phase and the step starting/ending events of all phases.
BestSolutionRecaller<Solution_>	getBestSolutionRecaller()
List<Phase<Solution_>>	getPhaseList()
boolean	isTerminationSameAsSolverTermination(PhaseTermination<Solution_> phaseTermination)
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
void	removeEventListener(SolverEventListener<Solution_> eventListener)
void	removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)
protected void	runPhases(SolverScope<Solution_> solverScope)
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingError(SolverScope<Solution_> solverScope, Exception exception)
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.api.solver.Solver

addProblemChange, addProblemChanges, addProblemFactChange, addProblemFactChanges, isEveryProblemChangeProcessed, isEveryProblemFactChangeProcessed, isSolving, isTerminateEarly, solve, terminateEarly

Field Details

logger

protected final transient org.slf4j.Logger logger

bestSolutionRecaller

protected final BestSolutionRecaller<Solution_> bestSolutionRecaller

globalTermination

protected final UniversalTermination<Solution_> globalTermination

phaseList

protected final List<Phase<Solution_>> phaseList

Constructor Details

AbstractSolver

protected AbstractSolver(BestSolutionRecaller<Solution_> bestSolutionRecaller,
 UniversalTermination<Solution_> globalTermination,
 List<Phase<Solution_>> phaseList)

Method Details

solvingStarted

public void solvingStarted(SolverScope<Solution_> solverScope)

runPhases

protected void runPhases(SolverScope<Solution_> solverScope)

solvingEnded

public void solvingEnded(SolverScope<Solution_> solverScope)

solvingError

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

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

phaseEnded

public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)

stepStarted

public void stepStarted(AbstractStepScope<Solution_> stepScope)

stepEnded

public void stepEnded(AbstractStepScope<Solution_> stepScope)

addEventListener

public void addEventListener(SolverEventListener<Solution_> eventListener)

Specified by:

addEventListener in interface Solver<Solution_>

removeEventListener

public void removeEventListener(SolverEventListener<Solution_> eventListener)

Specified by:

removeEventListener in interface Solver<Solution_>

addPhaseLifecycleListener

public void addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Add a PhaseLifecycleListener that is notified of solving events and also of the phase and the step starting/ending events of all phases.

To get notified for only 1 phase, use Phase.addPhaseLifecycleListener(PhaseLifecycleListener) instead.

Parameters:

phaseLifecycleListener - never null

removePhaseLifecycleListener

public void removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Parameters:

phaseLifecycleListener - never null

See Also:

• addPhaseLifecycleListener(PhaseLifecycleListener)

isTerminationSameAsSolverTermination

public boolean isTerminationSameAsSolverTermination(PhaseTermination<Solution_> phaseTermination)

getBestSolutionRecaller

public BestSolutionRecaller<Solution_> getBestSolutionRecaller()

getPhaseList

public List<Phase<Solution_>> getPhaseList()