Package org.optaplanner.core.impl.solver.termination

Class UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination

java.lang.Object

org.optaplanner.core.impl.solver.event.SolverLifecycleListenerAdapter<Solution_>

org.optaplanner.core.impl.phase.event.PhaseLifecycleListenerAdapter

org.optaplanner.core.impl.solver.termination.AbstractTermination

org.optaplanner.core.impl.solver.termination.UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination

All Implemented Interfaces:

EventListener, PhaseLifecycleListener, SolverLifecycleListener, Termination

public class UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination
extends AbstractTermination

Field Summary

Fields inherited from class org.optaplanner.core.impl.solver.termination.AbstractTermination

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
	UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination(long unimprovedTimeMillisSpentLimit, Score unimprovedScoreDifferenceThreshold)
protected	UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination(long unimprovedTimeMillisSpentLimit, Score unimprovedScoreDifferenceThreshold, Clock clock)

Method Summary

Modifier and Type	Method	Description
double	calculatePhaseTimeGradient(AbstractPhaseScope phaseScope)	See Termination.calculateSolverTimeGradient(DefaultSolverScope).
double	calculateSolverTimeGradient(DefaultSolverScope solverScope)	A timeGradient is a relative estimate of how long the search will continue.
protected double	calculateTimeGradient(long safeTimeMillis)
UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination	createChildThreadTermination(DefaultSolverScope solverScope, ChildThreadType childThreadType)	Create a Termination for a child Thread of the Solver.
Score	getUnimprovedScoreDifferenceThreshold()
long	getUnimprovedTimeMillisSpentLimit()
boolean	isPhaseTerminated(AbstractPhaseScope phaseScope)	Called by the Phase after every step and every move to determine if the search should stop.
boolean	isSolverTerminated(DefaultSolverScope solverScope)	Called by the Solver after every phase to determine if the search should stop.
protected boolean	isTerminated(long safeTimeMillis)
void	phaseEnded(AbstractPhaseScope phaseScope)
void	phaseStarted(AbstractPhaseScope phaseScope)
void	solvingEnded(DefaultSolverScope solverScope)
void	solvingStarted(DefaultSolverScope solverScope)
void	stepEnded(AbstractStepScope stepScope)
String	toString()

Methods inherited from class org.optaplanner.core.impl.phase.event.PhaseLifecycleListenerAdapter

stepStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener

stepStarted

Constructor Detail

UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination

public UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination(long unimprovedTimeMillisSpentLimit,
                                                                    Score unimprovedScoreDifferenceThreshold)

UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination

protected UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination(long unimprovedTimeMillisSpentLimit,
                                                                       Score unimprovedScoreDifferenceThreshold,
                                                                       Clock clock)

Method Detail

getUnimprovedTimeMillisSpentLimit

public long getUnimprovedTimeMillisSpentLimit()

getUnimprovedScoreDifferenceThreshold

public Score getUnimprovedScoreDifferenceThreshold()

solvingStarted

public void solvingStarted(DefaultSolverScope solverScope)

Specified by:

solvingStarted in interface SolverLifecycleListener

Overrides:

solvingStarted in class SolverLifecycleListenerAdapter

solvingEnded

public void solvingEnded(DefaultSolverScope solverScope)

Specified by:

solvingEnded in interface SolverLifecycleListener

Overrides:

solvingEnded in class SolverLifecycleListenerAdapter

phaseStarted

public void phaseStarted(AbstractPhaseScope phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener

Overrides:

phaseStarted in class PhaseLifecycleListenerAdapter

phaseEnded

public void phaseEnded(AbstractPhaseScope phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener

Overrides:

phaseEnded in class PhaseLifecycleListenerAdapter

stepEnded

public void stepEnded(AbstractStepScope stepScope)

Specified by:

stepEnded in interface PhaseLifecycleListener

Overrides:

stepEnded in class PhaseLifecycleListenerAdapter

isSolverTerminated

public boolean isSolverTerminated(DefaultSolverScope 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 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.

isTerminated

protected boolean isTerminated(long safeTimeMillis)

calculateSolverTimeGradient

public double calculateSolverTimeGradient(DefaultSolverScope 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 can not 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 phaseScope)

Description copied from interface: Termination

See Termination.calculateSolverTimeGradient(DefaultSolverScope).

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.

calculateTimeGradient

protected double calculateTimeGradient(long safeTimeMillis)

createChildThreadTermination

public UnimprovedTimeMillisSpentScoreDifferenceThresholdTermination createChildThreadTermination(DefaultSolverScope solverScope,
                                                                                                 ChildThreadType childThreadType)

Description copied from interface: Termination

Create a Termination for a child Thread of the Solver.

Specified by:

createChildThreadTermination in interface Termination

Overrides:

createChildThreadTermination in class AbstractTermination

Parameters:

solverScope - never null

childThreadType - never null

Returns:

not null

toString

public String toString()

Overrides:

toString in class Object