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

Class DefaultSolverJob<Solution_,ProblemId_>

java.lang.Object

ai.timefold.solver.core.impl.solver.DefaultSolverJob<Solution_,ProblemId_>

Type Parameters:

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

ProblemId_ - the ID type of submitted problem, such as Long or UUID.

All Implemented Interfaces:

SolverJob<Solution_,ProblemId_>, Callable<Solution_>

public final class DefaultSolverJob<Solution_,ProblemId_>
extends Object
implements SolverJob<Solution_,ProblemId_>, Callable<Solution_>

Constructor Summary

Constructors

Constructor

Description

DefaultSolverJob(DefaultSolverManager<Solution_,ProblemId_> solverManager, Solver<Solution_> solver, ProblemId_ problemId, Function<? super ProblemId_,? extends Solution_> problemFinder, Consumer<? super Solution_> bestSolutionConsumer, Consumer<? super Solution_> finalBestSolutionConsumer, SolverJobBuilder.FirstInitializedSolutionConsumer<? super Solution_> firstInitializedSolutionConsumer, Consumer<? super Solution_> solverJobStartedConsumer, BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler)

Method Summary

Modifier and Type	Method	Description
@NonNull CompletableFuture<Void>	addProblemChanges(@NonNull List<ProblemChange<Solution_>> problemChangeList)	Schedules a batch of problem changes to be processed by the underlying Solver and returns immediately.
Solution_	call()
@NonNull Solution_	getFinalBestSolution()	Waits if necessary for the solver to complete and then returns the final best PlanningSolution.
long	getMoveEvaluationCount()	Return the number of move evaluations since the last start.
long	getMoveEvaluationSpeed()	Return the average number of move evaluations per second since the last start.
@NonNull ProblemId_	getProblemId()
@NonNull ProblemSizeStatistics	getProblemSizeStatistics()	Return the ProblemSizeStatistics for the problem submitted to the SolverManager.
long	getScoreCalculationCount()	Return the number of score calculations since the last start.
long	getScoreCalculationSpeed()	Return the average number of score calculations per second since the last start.
@NonNull SolverStatus	getSolverStatus()	Returns whether the Solver is scheduled to solve, actively solving or not.
SolverTermination<Solution_>	getSolverTermination()
@NonNull Duration	getSolvingDuration()	Returns the Duration spent solving since the last start.
boolean	isTerminatedEarly()
void	setFinalBestSolutionFuture(Future<Solution_> finalBestSolutionFuture)
void	terminateEarly()	Terminates the solver or cancels the solver job if it hasn't (re)started yet.

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.SolverJob

addProblemChange

Constructor Details

DefaultSolverJob

public DefaultSolverJob(DefaultSolverManager<Solution_,ProblemId_> solverManager,
 Solver<Solution_> solver,
 ProblemId_ problemId,
 Function<? super ProblemId_,? extends Solution_> problemFinder,
 Consumer<? super Solution_> bestSolutionConsumer,
 Consumer<? super Solution_> finalBestSolutionConsumer,
 SolverJobBuilder.FirstInitializedSolutionConsumer<? super Solution_> firstInitializedSolutionConsumer,
 Consumer<? super Solution_> solverJobStartedConsumer,
 BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler)

Method Details

setFinalBestSolutionFuture

public void setFinalBestSolutionFuture(Future<Solution_> finalBestSolutionFuture)

getProblemId

public @NonNull ProblemId_ getProblemId()

Specified by:

getProblemId in interface SolverJob<Solution_,ProblemId_>

Returns:

a value given to SolverManager.solve(Object, Object, Consumer) or SolverManager.solveAndListen(Object, Object, Consumer)

getSolverStatus

public @NonNull SolverStatus getSolverStatus()

Description copied from interface: SolverJob

Returns whether the Solver is scheduled to solve, actively solving or not.

Returns SolverStatus.NOT_SOLVING if the solver already terminated.

Specified by:

getSolverStatus in interface SolverJob<Solution_,ProblemId_>

call

public Solution_ call()

Specified by:

call in interface Callable<Solution_>

addProblemChanges

public @NonNull CompletableFuture<Void> addProblemChanges(@NonNull List<ProblemChange<Solution_>> problemChangeList)

Description copied from interface: SolverJob

Schedules a batch of problem changes to be processed by the underlying Solver and returns immediately.

Specified by:

addProblemChanges in interface SolverJob<Solution_,ProblemId_>

Parameters:

problemChangeList - at least one problem change to be processed

Returns:

completes after the best solution containing this change has been consumed.

See Also:

• Learn more about problem change semantics.

terminateEarly

public void terminateEarly()

Description copied from interface: SolverJob

Terminates the solver or cancels the solver job if it hasn't (re)started yet.

Does nothing if the solver already terminated.

Waits for the termination or cancellation to complete before returning. During termination, a bestSolutionConsumer could still be called. When the solver terminates, the finalBestSolutionConsumer is executed with the latest best solution. These consumers run on a consumer thread independently of the termination and may still run even after this method returns.

Specified by:

terminateEarly in interface SolverJob<Solution_,ProblemId_>

isTerminatedEarly

public boolean isTerminatedEarly()

Specified by:

isTerminatedEarly in interface SolverJob<Solution_,ProblemId_>

Returns:

true if SolverJob.terminateEarly() has been called since the underlying Solver started solving.

getFinalBestSolution

public @NonNull Solution_ getFinalBestSolution()
                                        throws InterruptedException,
ExecutionException

Description copied from interface: SolverJob

Waits if necessary for the solver to complete and then returns the final best PlanningSolution.

Specified by:

getFinalBestSolution in interface SolverJob<Solution_,ProblemId_>

Returns:

never null, but it could be the original uninitialized problem

Throws:

InterruptedException - if the current thread was interrupted while waiting

ExecutionException - if the computation threw an exception

getSolvingDuration

public @NonNull Duration getSolvingDuration()

Description copied from interface: SolverJob

Returns the Duration spent solving since the last start. If it hasn't started it yet, it returns Duration.ZERO. If it hasn't ended yet, it returns the time between the last start and now. If it has ended already, it returns the time between the last start and the ending.

Specified by:

getSolvingDuration in interface SolverJob<Solution_,ProblemId_>

Returns:

the Duration spent solving since the last (re)start, at least 0

getScoreCalculationCount

public long getScoreCalculationCount()

Description copied from interface: SolverJob

Return the number of score calculations since the last start. If it hasn't started yet, it returns 0. If it hasn't ended yet, it returns the number of score calculations so far. If it has ended already, it returns the total number of score calculations that occurred during solving.

Specified by:

getScoreCalculationCount in interface SolverJob<Solution_,ProblemId_>

Returns:

the number of score calculations that had occurred during solving since the last (re)start, at least 0

getMoveEvaluationCount

public long getMoveEvaluationCount()

Description copied from interface: SolverJob

Return the number of move evaluations since the last start. If it hasn't started yet, it returns 0. If it hasn't ended yet, it returns the number of moves evaluations so far. If it has ended already, it returns the total number of move evaluations that occurred during solving.

Specified by:

getMoveEvaluationCount in interface SolverJob<Solution_,ProblemId_>

Returns:

the number of move evaluations that had occurred during solving since the last (re)start, at least 0

getScoreCalculationSpeed

public long getScoreCalculationSpeed()

Description copied from interface: SolverJob

Return the average number of score calculations per second since the last start. If it hasn't started yet, it returns 0. If it hasn't ended yet, it returns the average number of score calculations per second so far. If it has ended already, it returns the average number of score calculations per second during solving.

Specified by:

getScoreCalculationSpeed in interface SolverJob<Solution_,ProblemId_>

Returns:

the average number of score calculations per second that had occurred during solving since the last (re)start, at least 0

getMoveEvaluationSpeed

public long getMoveEvaluationSpeed()

Description copied from interface: SolverJob

Return the average number of move evaluations per second since the last start. If it hasn't started yet, it returns 0. If it hasn't ended yet, it returns the average number of move evaluations per second so far. If it has ended already, it returns the average number of move evaluations per second during solving.

Specified by:

getMoveEvaluationSpeed in interface SolverJob<Solution_,ProblemId_>

Returns:

the average number of move evaluations per second that had occurred during solving since the last (re)start, at least 0

getProblemSizeStatistics

public @NonNull ProblemSizeStatistics getProblemSizeStatistics()

Description copied from interface: SolverJob

Return the ProblemSizeStatistics for the problem submitted to the SolverManager.

Specified by:

getProblemSizeStatistics in interface SolverJob<Solution_,ProblemId_>

getSolverTermination

public SolverTermination<Solution_> getSolverTermination()