Package org.optaplanner.core.impl.solver

Class DefaultSolver<Solution_>

java.lang.Object

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

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 AbstractSolver<Solution_>

Default implementation for Solver.

See Also:

• Solver
• AbstractSolver

Field Summary

Fields

Modifier and Type	Field	Description
protected BasicPlumbingTermination<Solution_>	basicPlumbingTermination
protected EnvironmentMode	environmentMode
protected RandomFactory	randomFactory
protected final SolverScope<Solution_>	solverScope
protected final AtomicBoolean	solving

Fields inherited from class org.optaplanner.core.impl.solver.AbstractSolver

bestSolutionRecaller, logger, phaseList, solverTermination

Constructor Summary

Constructors

Constructor	Description
DefaultSolver(EnvironmentMode environmentMode, RandomFactory randomFactory, BestSolutionRecaller<Solution_> bestSolutionRecaller, BasicPlumbingTermination<Solution_> basicPlumbingTermination, Termination<Solution_> termination, List<Phase<Solution_>> phaseList, SolverScope<Solution_> solverScope, String moveThreadCountDescription)

Method Summary

Modifier and Type	Method	Description
void	addProblemChange(ProblemChange<Solution_> problemChange)	Schedules a ProblemChange to be processed.
void	addProblemChanges(List<ProblemChange<Solution_>> problemChangeList)	Schedules multiple ProblemChanges to be processed.
boolean	addProblemFactChange(ProblemFactChange<Solution_> problemFactChange)	This method is deprecated.
boolean	addProblemFactChanges(List<ProblemFactChange<Solution_>> problemFactChangeList)	This method is deprecated.
EnvironmentMode	getEnvironmentMode()
RandomFactory	getRandomFactory()
InnerScoreDirectorFactory<Solution_,?>	getScoreDirectorFactory()
SolverScope<Solution_>	getSolverScope()
long	getTimeMillisSpent()
boolean	isEveryProblemChangeProcessed()	Checks if all scheduled ProblemChanges have been processed.
boolean	isEveryProblemFactChangeProcessed()	This method is deprecated.
boolean	isSolving()	This method is thread-safe.
boolean	isTerminateEarly()	This method is thread-safe.
void	outerSolvingEnded(SolverScope<Solution_> solverScope)
void	outerSolvingStarted(SolverScope<Solution_> solverScope)
void	setMonitorTagMap(Map<String,String> monitorTagMap)
final Solution_	solve(Solution_ problem)	Solves the planning problem and returns the best solution encountered (which might or might not be optimal, feasible or even initialized).
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingStarted(SolverScope<Solution_> solverScope)
boolean	terminateEarly()	Notifies the solver that it should stop at its earliest convenience.

Methods inherited from class org.optaplanner.core.impl.solver.AbstractSolver

addEventListener, addPhaseLifecycleListener, getBestSolutionRecaller, getPhaseList, phaseEnded, phaseStarted, removeEventListener, removePhaseLifecycleListener, runPhases, solvingError, stepEnded, stepStarted

Methods inherited from class java.lang.Object

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

Field Details

environmentMode

protected EnvironmentMode environmentMode

randomFactory

protected RandomFactory randomFactory

basicPlumbingTermination

protected BasicPlumbingTermination<Solution_> basicPlumbingTermination

solving

protected final AtomicBoolean solving

solverScope

protected final SolverScope<Solution_> solverScope

Constructor Details

DefaultSolver

public DefaultSolver(EnvironmentMode environmentMode,
 RandomFactory randomFactory,
 BestSolutionRecaller<Solution_> bestSolutionRecaller,
 BasicPlumbingTermination<Solution_> basicPlumbingTermination,
 Termination<Solution_> termination,
 List<Phase<Solution_>> phaseList,
 SolverScope<Solution_> solverScope,
 String moveThreadCountDescription)

Method Details

getEnvironmentMode

public EnvironmentMode getEnvironmentMode()

getRandomFactory

public RandomFactory getRandomFactory()

getScoreDirectorFactory

public InnerScoreDirectorFactory<Solution_,?> getScoreDirectorFactory()

getSolverScope

public SolverScope<Solution_> getSolverScope()

getTimeMillisSpent

public long getTimeMillisSpent()

isSolving

public boolean isSolving()

Description copied from interface: Solver

This method is thread-safe.

Returns:

true if the Solver.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 Solver.solve(Solution_) to actually return.

If the solver is running in daemon mode, this is the only way to terminate it normally.

This method is thread-safe. It can only be called from a different thread because the original thread is still calling Solver.solve(Object).

Returns:

true if successful, false if was already terminating or terminated

See Also:

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

isTerminateEarly

public boolean isTerminateEarly()

Description copied from interface: Solver

This method is thread-safe.

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

This method is deprecated. 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.

Parameters:

problemFactChange - never null

Returns:

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

See Also:

• Solver.addProblemFactChanges(List)

addProblemFactChanges

public boolean addProblemFactChanges(List<ProblemFactChange<Solution_>> problemFactChangeList)

Description copied from interface: Solver

This method is deprecated. Schedules multiple ProblemFactChanges 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 Collection.addAll(Collection) with by default a capacity of Integer.MAX_VALUE.

Parameters:

problemFactChangeList - never null

Returns:

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

See Also:

• Solver.addProblemFactChange(ProblemFactChange)

addProblemChange

public void addProblemChange(ProblemChange<Solution_> problemChange)

Description copied from interface: Solver

Schedules a ProblemChange 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.

To learn more about problem change semantics, please refer to the ProblemChange Javadoc.

Parameters:

problemChange - never null

See Also:

• Solver.addProblemChanges(List)

addProblemChanges

public void addProblemChanges(List<ProblemChange<Solution_>> problemChangeList)

Description copied from interface: Solver

Schedules multiple ProblemChanges 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.

To learn more about problem change semantics, please refer to the ProblemChange Javadoc.

Parameters:

problemChangeList - never null

See Also:

• Solver.addProblemChange(ProblemChange)

isEveryProblemChangeProcessed

public boolean isEveryProblemChangeProcessed()

Description copied from interface: Solver

Checks if all scheduled ProblemChanges have been processed.

This method is thread-safe.

Returns:

true if there are no ProblemChanges left to do

isEveryProblemFactChangeProcessed

public boolean isEveryProblemFactChangeProcessed()

Description copied from interface: Solver

This method is deprecated. Checks if all scheduled ProblemFactChanges have been processed.

This method is thread-safe.

Returns:

true if there are no ProblemFactChanges left to do

setMonitorTagMap

public void setMonitorTagMap(Map<String,String> monitorTagMap)

solve

public final Solution_ solve(Solution_ problem)

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().

Parameters:

problem - never null, a PlanningSolution, usually its planning variables are uninitialized

Returns:

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

See Also:

• Solver.terminateEarly()

outerSolvingStarted

public void outerSolvingStarted(SolverScope<Solution_> solverScope)

solvingStarted

public void solvingStarted(SolverScope<Solution_> solverScope)

Overrides:

solvingStarted in class AbstractSolver<Solution_>

solvingEnded

public void solvingEnded(SolverScope<Solution_> solverScope)

Overrides:

solvingEnded in class AbstractSolver<Solution_>

outerSolvingEnded

public void outerSolvingEnded(SolverScope<Solution_> solverScope)