org.optaplanner.core.impl.solver

Class DefaultSolver<Solution_>

java.lang.Object

org.optaplanner.core.impl.solver.DefaultSolver<Solution_>

Type Parameters:

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

All Implemented Interfaces:

Solver<Solution_>

public class DefaultSolver<Solution_>
extends Object
implements Solver<Solution_>

Default implementation for Solver.

See Also:

Solver

Field Summary

Fields

Modifier and Type	Field and Description
protected BasicPlumbingTermination	basicPlumbingTermination
protected BestSolutionRecaller<Solution_>	bestSolutionRecaller
protected boolean	constraintMatchEnabledPreference
protected EnvironmentMode	environmentMode
protected org.slf4j.Logger	logger
protected PhaseLifecycleSupport<Solution_>	phaseLifecycleSupport
protected List<Phase>	phaseList
protected RandomFactory	randomFactory
protected InnerScoreDirectorFactory<Solution_>	scoreDirectorFactory
protected SolverEventSupport<Solution_>	solverEventSupport
protected DefaultSolverScope<Solution_>	solverScope
protected AtomicBoolean	solving
protected Termination	termination

Constructor Summary

Constructors

Constructor and Description
DefaultSolver()

Method Summary

Modifier and Type	Method and Description
void	addEventListener(SolverEventListener<Solution_> eventListener)
void	addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener) Add a PhaseLifecycleListener that is notified of SolverLifecycleListener.solvingStarted(DefaultSolverScope) solving} events and also of the phase and the PhaseLifecycleListener.stepStarted(AbstractStepScope) step} starting/ending events of all phases.
boolean	addProblemFactChange(ProblemFactChange<Solution_> problemFactChange) Schedules a ProblemFactChange to be processed.
Score	getBestScore() Returns the Score of the Solver.getBestSolution().
Solution_	getBestSolution() The best solution is the best solution found during solving: it might or might not be optimal, feasible or even initialized.
BestSolutionRecaller<Solution_>	getBestSolutionRecaller()
EnvironmentMode	getEnvironmentMode()
List<Phase>	getPhaseList()
RandomFactory	getRandomFactory()
InnerScoreDirectorFactory<Solution_>	getScoreDirectorFactory() Useful to reuse the Score calculation in a UI (or even to explain the Score in a UI).
DefaultSolverScope<Solution_>	getSolverScope()
long	getTimeMillisSpent()
boolean	isConstraintMatchEnabledPreference()
boolean	isEveryProblemFactChangeProcessed() Checks if all scheduled ProblemFactChanges have been processed.
boolean	isSolving() This method is thread-safe.
boolean	isTerminateEarly() This method is thread-safe.
void	outerSolvingEnded(DefaultSolverScope<Solution_> solverScope)
void	outerSolvingStarted(DefaultSolverScope<Solution_> solverScope)
void	removeEventListener(SolverEventListener<Solution_> eventListener)
void	removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)
protected void	runPhases()
void	setBasicPlumbingTermination(BasicPlumbingTermination basicPlumbingTermination)
void	setBestSolutionRecaller(BestSolutionRecaller<Solution_> bestSolutionRecaller)
void	setConstraintMatchEnabledPreference(boolean constraintMatchEnabledPreference)
void	setEnvironmentMode(EnvironmentMode environmentMode)
void	setPhaseList(List<Phase> phaseList)
void	setRandomFactory(RandomFactory randomFactory)
void	setScoreDirectorFactory(InnerScoreDirectorFactory<Solution_> scoreDirectorFactory)
void	setTermination(Termination termination)
Solution_	solve(Solution_ planningProblem) Solves the planning problem and returns the best solution encountered (which might or might not be optimal, feasible or even initialized).
void	solvingEnded(DefaultSolverScope<Solution_> solverScope)
void	solvingStarted(DefaultSolverScope<Solution_> solverScope)
boolean	terminateEarly() Notifies the solver that it should stop at its earliest convenience.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient org.slf4j.Logger logger

solverEventSupport

protected SolverEventSupport<Solution_> solverEventSupport

phaseLifecycleSupport

protected PhaseLifecycleSupport<Solution_> phaseLifecycleSupport

environmentMode

protected EnvironmentMode environmentMode

randomFactory

protected RandomFactory randomFactory

constraintMatchEnabledPreference

protected boolean constraintMatchEnabledPreference

scoreDirectorFactory

protected InnerScoreDirectorFactory<Solution_> scoreDirectorFactory

basicPlumbingTermination

protected BasicPlumbingTermination basicPlumbingTermination

termination

protected Termination termination

bestSolutionRecaller

protected BestSolutionRecaller<Solution_> bestSolutionRecaller

phaseList

protected List<Phase> phaseList

solving

protected AtomicBoolean solving

solverScope

protected DefaultSolverScope<Solution_> solverScope

Constructor Detail

DefaultSolver

public DefaultSolver()

Method Detail

getEnvironmentMode

public EnvironmentMode getEnvironmentMode()

setEnvironmentMode

public void setEnvironmentMode(EnvironmentMode environmentMode)

getRandomFactory

public RandomFactory getRandomFactory()

setRandomFactory

public void setRandomFactory(RandomFactory randomFactory)

isConstraintMatchEnabledPreference

public boolean isConstraintMatchEnabledPreference()

setConstraintMatchEnabledPreference

public void setConstraintMatchEnabledPreference(boolean constraintMatchEnabledPreference)

getScoreDirectorFactory

public InnerScoreDirectorFactory<Solution_> getScoreDirectorFactory()

Description copied from interface: Solver

Useful to reuse the Score calculation in a UI (or even to explain the Score in a UI).

Specified by:

getScoreDirectorFactory in interface Solver<Solution_>

Returns:

never null

setScoreDirectorFactory

public void setScoreDirectorFactory(InnerScoreDirectorFactory<Solution_> scoreDirectorFactory)

setBasicPlumbingTermination

public void setBasicPlumbingTermination(BasicPlumbingTermination basicPlumbingTermination)

setTermination

public void setTermination(Termination termination)

getBestSolutionRecaller

public BestSolutionRecaller<Solution_> getBestSolutionRecaller()

setBestSolutionRecaller

public void setBestSolutionRecaller(BestSolutionRecaller<Solution_> bestSolutionRecaller)

getPhaseList

public List<Phase> getPhaseList()

setPhaseList

public void setPhaseList(List<Phase> phaseList)

getSolverScope

public DefaultSolverScope<Solution_> getSolverScope()

getBestSolution

public Solution_ getBestSolution()

Description copied from interface: Solver

The best solution is the best solution found during solving: it might or might not be optimal, feasible or even initialized.

The #solve(Solution_) method also returns the best solution, but this method is useful in rare asynchronous situations (although SolverEventListener.bestSolutionChanged(BestSolutionChangedEvent) is often more appropriate).

This method is thread-safe.

Specified by:

getBestSolution in interface Solver<Solution_>

Returns:

never null, but it can return the original, uninitialized PlanningSolution with a Score null.

getBestScore

public Score getBestScore()

Description copied from interface: Solver

Returns the Score of the Solver.getBestSolution().

This is useful for generic code, which doesn't know the type of the PlanningSolution to retrieve the Score from the Solver.getBestSolution() easily.

Specified by:

getBestScore in interface Solver<Solution_>

Returns:

null if the PlanningSolution is still uninitialized

getTimeMillisSpent

public long getTimeMillisSpent()

Specified by:

getTimeMillisSpent in interface Solver<Solution_>

Returns:

the amount of millis spent between when this solver started (or last restarted) and ended

isSolving

public boolean isSolving()

Description copied from interface: Solver

This method is thread-safe.

Specified by:

isSolving in interface Solver<Solution_>

Returns:

true if the #solve(Solution_) method is still running.

terminateEarly

public boolean terminateEarly()

Description copied from interface: Solver

Notifies the solver that it should stop at its earliest convenience. This method returns immediately, but it takes an undetermined time for the #solve(Solution_) to actually return.

This method is thread-safe.

Specified by:

terminateEarly in interface Solver<Solution_>

Returns:

true if successful

See Also:

Solver.isTerminateEarly(), Future.cancel(boolean)

isTerminateEarly

public boolean isTerminateEarly()

Description copied from interface: Solver

This method is thread-safe.

Specified by:

isTerminateEarly in interface Solver<Solution_>

Returns:

true if terminateEarly has been called since the Solver started.

See Also:

Future.isCancelled()

addProblemFactChange

public boolean addProblemFactChange(ProblemFactChange<Solution_> problemFactChange)

Description copied from interface: Solver

Schedules a ProblemFactChange to be processed.

As a side-effect, this restarts the Solver, effectively resetting all Terminations, but not Solver.terminateEarly().

This method is thread-safe. Follows specifications of BlockingQueue.add(Object) with by default a capacity of Integer.MAX_VALUE.

Specified by:

addProblemFactChange in interface Solver<Solution_>

Parameters:

problemFactChange - never null

Returns:

true (as specified by Collection.add(E))

isEveryProblemFactChangeProcessed

public boolean isEveryProblemFactChangeProcessed()

Description copied from interface: Solver

Checks if all scheduled ProblemFactChanges have been processed.

This method is thread-safe.

Specified by:

isEveryProblemFactChangeProcessed in interface Solver<Solution_>

Returns:

true if there are no ProblemFactChanges left to do

solve

public final Solution_ solve(Solution_ planningProblem)

Description copied from interface: Solver

Solves the planning problem and returns the best solution encountered (which might or might not be optimal, feasible or even initialized).

It can take seconds, minutes, even hours or days before this method returns, depending on the Termination configuration. To terminate a Solver early, call Solver.terminateEarly().

Specified by:

solve in interface Solver<Solution_>

Parameters:

planningProblem - never null, usually its planning variables are uninitialized

Returns:

never null, but it can return the original, uninitialized PlanningSolution with a Score null.

See Also:

Solver.terminateEarly()

outerSolvingStarted

public void outerSolvingStarted(DefaultSolverScope<Solution_> solverScope)

solvingStarted

public void solvingStarted(DefaultSolverScope<Solution_> solverScope)

runPhases

protected void runPhases()

solvingEnded

public void solvingEnded(DefaultSolverScope<Solution_> solverScope)

outerSolvingEnded

public void outerSolvingEnded(DefaultSolverScope<Solution_> solverScope)

addEventListener

public void addEventListener(SolverEventListener<Solution_> eventListener)

Specified by:

addEventListener in interface Solver<Solution_>

Parameters:

eventListener - never null

removeEventListener

public void removeEventListener(SolverEventListener<Solution_> eventListener)

Specified by:

removeEventListener in interface Solver<Solution_>

Parameters:

eventListener - never null

addPhaseLifecycleListener

public void addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Add a PhaseLifecycleListener that is notified of SolverLifecycleListener.solvingStarted(DefaultSolverScope) solving} events and also of the phase and the PhaseLifecycleListener.stepStarted(AbstractStepScope) 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)