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

Class DefaultSolverManager<Solution_,ProblemId_>

java.lang.Object

ai.timefold.solver.core.impl.solver.DefaultSolverManager<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:

SolverManager<Solution_,ProblemId_>, AutoCloseable

public final class DefaultSolverManager<Solution_,ProblemId_>
extends Object
implements SolverManager<Solution_,ProblemId_>

Constructor Summary

Constructors

Constructor	Description
DefaultSolverManager(SolverFactory<Solution_> solverFactory, SolverManagerConfig solverManagerConfig)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addProblemChange(ProblemId_ problemId, ProblemChange<Solution_> problemChange)	Schedules a ProblemChange to be processed by the underlying Solver and returns immediately.
void	close()	Terminates all solvers, cancels all solver jobs that haven't (re)started yet and discards all queued ProblemChanges.
SolverFactory<Solution_>	getSolverFactory()
SolverStatus	getSolverStatus(ProblemId_ problemId)	Returns if the Solver is scheduled to solve, actively solving or not.
protected SolverJob<Solution_,ProblemId_>	solve(ProblemId_ problemId, Function<? super ProblemId_,? extends Solution_> problemFinder, Consumer<? super Solution_> bestSolutionConsumer, Consumer<? super Solution_> finalBestSolutionConsumer, Consumer<? super Solution_> initializedSolutionConsumer, Consumer<? super Solution_> solverJobStartedConsumer, BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler, SolverConfigOverride<Solution_> configOverride)
protected SolverJob<Solution_,ProblemId_>	solveAndListen(ProblemId_ problemId, Function<? super ProblemId_,? extends Solution_> problemFinder, Consumer<? super Solution_> bestSolutionConsumer, Consumer<? super Solution_> finalBestSolutionConsumer, Consumer<? super Solution_> initializedSolutionConsumer, Consumer<? super Solution_> solverJobStartedConsumer, BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler, SolverConfigOverride<Solution_> solverConfigOverride)
SolverJobBuilder<Solution_,ProblemId_>	solveBuilder()	Creates a Builder that allows to customize and submit a planning problem to solve.
void	terminateEarly(ProblemId_ problemId)	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.SolverManager

solve, solve, solve, solve, solve, solveAndListen, solveAndListen, solveAndListen, solveAndListen

Constructor Details

DefaultSolverManager

public DefaultSolverManager(SolverFactory<Solution_> solverFactory,
 SolverManagerConfig solverManagerConfig)

Method Details

getSolverFactory

public SolverFactory<Solution_> getSolverFactory()

solveBuilder

public SolverJobBuilder<Solution_,ProblemId_> solveBuilder()

Description copied from interface: SolverManager

Creates a Builder that allows to customize and submit a planning problem to solve.

Specified by:

solveBuilder in interface SolverManager<Solution_,ProblemId_>

Returns:

never null

solveAndListen

protected SolverJob<Solution_,ProblemId_> solveAndListen(ProblemId_ problemId,
 Function<? super ProblemId_,? extends Solution_> problemFinder,
 Consumer<? super Solution_> bestSolutionConsumer,
 Consumer<? super Solution_> finalBestSolutionConsumer,
 Consumer<? super Solution_> initializedSolutionConsumer,
 Consumer<? super Solution_> solverJobStartedConsumer,
 BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler,
 SolverConfigOverride<Solution_> solverConfigOverride)

solve

protected SolverJob<Solution_,ProblemId_> solve(ProblemId_ problemId,
 Function<? super ProblemId_,? extends Solution_> problemFinder,
 Consumer<? super Solution_> bestSolutionConsumer,
 Consumer<? super Solution_> finalBestSolutionConsumer,
 Consumer<? super Solution_> initializedSolutionConsumer,
 Consumer<? super Solution_> solverJobStartedConsumer,
 BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler,
 SolverConfigOverride<Solution_> configOverride)

getSolverStatus

public SolverStatus getSolverStatus(ProblemId_ problemId)

Description copied from interface: SolverManager

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

Returns SolverStatus.NOT_SOLVING if the solver already terminated or if the problemId was never added. To distinguish between both cases, use SolverJob.getSolverStatus() instead. Here, that distinction is not supported because it would cause a memory leak.

Specified by:

getSolverStatus in interface SolverManager<Solution_,ProblemId_>

Parameters:

problemId - never null, a value given to SolverManager.solve(Object, Object, Consumer) or SolverManager.solveAndListen(Object, Object, Consumer)

Returns:

never null

addProblemChange

public CompletableFuture<Void> addProblemChange(ProblemId_ problemId,
 ProblemChange<Solution_> problemChange)

Description copied from interface: SolverManager

Schedules a ProblemChange to be processed by the underlying Solver and returns immediately. If the solver already terminated or the problemId was never added, throws an exception. The same applies if the underlying Solver is not in the SolverStatus.SOLVING_ACTIVE state.

Specified by:

addProblemChange in interface SolverManager<Solution_,ProblemId_>

Parameters:

problemId - never null, a value given to SolverManager.solve(Object, Object, Consumer) or SolverManager.solveAndListen(Object, Object, Consumer)

problemChange - never null

Returns:

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

terminateEarly

public void terminateEarly(ProblemId_ problemId)

Description copied from interface: SolverManager

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

Does nothing if the solver already terminated or the problemId was never added. To distinguish between both cases, use SolverJob.terminateEarly() instead. Here, that distinction is not supported because it would cause a memory leak.

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 SolverManager<Solution_,ProblemId_>

Parameters:

problemId - never null, a value given to SolverManager.solve(Object, Object, Consumer) or SolverManager.solveAndListen(Object, Object, Consumer)

close

public void close()

Description copied from interface: SolverManager

Terminates all solvers, cancels all solver jobs that haven't (re)started yet and discards all queued ProblemChanges. Releases all thread pool resources.

No new planning problems can be submitted after calling this method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SolverManager<Solution_,ProblemId_>