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

Class UnimprovedTimeMillisSpentTermination<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.solver.event.SolverLifecycleListenerAdapter<Solution_>

ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListenerAdapter<Solution_>

ai.timefold.solver.core.impl.solver.termination.AbstractTermination<Solution_>

ai.timefold.solver.core.impl.solver.termination.UnimprovedTimeMillisSpentTermination<Solution_>

All Implemented Interfaces:

PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>, Termination<Solution_>, EventListener

public final class UnimprovedTimeMillisSpentTermination<Solution_>
extends AbstractTermination<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.solver.termination.AbstractTermination

logger

Constructor Summary

Constructors

Constructor	Description
UnimprovedTimeMillisSpentTermination(long unimprovedTimeMillisSpentLimit)

Method Summary

Modifier and Type	Method	Description
double	calculatePhaseTimeGradient(AbstractPhaseScope<Solution_> phaseScope)	See Termination.calculateSolverTimeGradient(SolverScope).
double	calculateSolverTimeGradient(SolverScope<Solution_> solverScope)	A timeGradient is a relative estimate of how long the search will continue.
UnimprovedTimeMillisSpentTermination<Solution_>	createChildThreadTermination(SolverScope<Solution_> solverScope, ChildThreadType childThreadType)	Create a Termination for a child Thread of the Solver.
long	getUnimprovedTimeMillisSpentLimit()
boolean	isPhaseTerminated(AbstractPhaseScope<Solution_> phaseScope)	Called by the Phase after every step and every move to determine if the search should stop.
boolean	isSolverTerminated(SolverScope<Solution_> solverScope)	Called by the Solver after every phase to determine if the search should stop.
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
String	toString()

Methods inherited from class ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListenerAdapter

phaseEnded, stepEnded, stepStarted

Methods inherited from class ai.timefold.solver.core.impl.solver.event.SolverLifecycleListenerAdapter

solvingEnded, solvingStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, stepEnded, stepStarted

Methods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener

solvingEnded, solvingError, solvingStarted

Constructor Details

UnimprovedTimeMillisSpentTermination

public UnimprovedTimeMillisSpentTermination(long unimprovedTimeMillisSpentLimit)

Method Details

getUnimprovedTimeMillisSpentLimit

public long getUnimprovedTimeMillisSpentLimit()

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseStarted in class PhaseLifecycleListenerAdapter<Solution_>

isSolverTerminated

public boolean isSolverTerminated(SolverScope<Solution_> solverScope)

Description copied from interface: Termination

Called by the Solver after every phase to determine if the search should stop.

Parameters:

solverScope - never null

Returns:

true if the search should terminate.

isPhaseTerminated

public boolean isPhaseTerminated(AbstractPhaseScope<Solution_> phaseScope)

Description copied from interface: Termination

Called by the Phase after every step and every move to determine if the search should stop.

Parameters:

phaseScope - never null

Returns:

true if the search should terminate.

calculateSolverTimeGradient

public double calculateSolverTimeGradient(SolverScope<Solution_> solverScope)

Description copied from interface: Termination

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.

Parameters:

solverScope - never null

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.

calculatePhaseTimeGradient

public double calculatePhaseTimeGradient(AbstractPhaseScope<Solution_> phaseScope)

Description copied from interface: Termination

See Termination.calculateSolverTimeGradient(SolverScope).

Parameters:

phaseScope - never null

Returns:

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

createChildThreadTermination

public UnimprovedTimeMillisSpentTermination<Solution_> createChildThreadTermination(SolverScope<Solution_> solverScope,
 ChildThreadType childThreadType)

Description copied from interface: Termination

Create a Termination for a child Thread of the Solver.

Specified by:

createChildThreadTermination in interface Termination<Solution_>

Overrides:

createChildThreadTermination in class AbstractTermination<Solution_>

Parameters:

solverScope - never null

childThreadType - never null

Returns:

not null

toString

public String toString()

Overrides:

toString in class Object