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

Interface SolverTermination<Solution_>

All Superinterfaces:
EventListener, SolverLifecycleListener<Solution_>, Termination<Solution_>
All Known Subinterfaces:
UniversalTermination<Solution_>
All Known Implementing Classes:
BasicPlumbingTermination, ChildThreadPlumbingTermination
@NullMarked public sealed interface SolverTermination<Solution_> extends Termination<Solution_>, SolverLifecycleListener<Solution_> permits UniversalTermination<Solution_> (not exhaustive)
Determines when a Solver should stop.

  • Method Details

    • isSolverTerminated

      boolean isSolverTerminated(SolverScope<Solution_> solverScope)
      Called by the Solver after every phase to determine if the search should stop.
      Returns:
      true if the search should terminate.

    • calculateSolverTimeGradient

      double calculateSolverTimeGradient(SolverScope<Solution_> solverScope)
      A timeGradient is a relative estimate of how long the search will continue.

      Clients that use a timeGradient should cache it at the start of a single step because some implementations are not time-stable.

      If a timeGradient cannot be calculated, it should return -1.0. Several implementations (such a SimulatedAnnealingAcceptor) require a correctly implemented timeGradient.

      A Termination's timeGradient can be requested after they are terminated, so implementations should be careful not to return a timeGradient above 1.0.

      Returns:
      timeGradient t for which 0.0 <= t <= 1.0 or -1.0 when it is not supported. At the start of a solver t is 0.0 and at the end t would be 1.0.