org.drools.planner.core.termination
Class TimeMillisSpendTermination

java.lang.Object
  org.drools.planner.core.solver.event.SolverLifecycleListenerAdapter
      org.drools.planner.core.phase.event.SolverPhaseLifecycleListenerAdapter
          org.drools.planner.core.termination.AbstractTermination
              org.drools.planner.core.termination.TimeMillisSpendTermination

All Implemented Interfaces:

EventListener, SolverPhaseLifecycleListener, SolverLifecycleListener, Termination

public class TimeMillisSpendTermination
extends AbstractTermination

Field Summary

Fields inherited from class org.drools.planner.core.termination.AbstractTermination

logger

Constructor Summary

TimeMillisSpendTermination()

Method Summary

double	calculatePhaseTimeGradient(AbstractSolverPhaseScope phaseScope) See Termination.calculateSolverTimeGradient(DefaultSolverScope).
double	calculateSolverTimeGradient(DefaultSolverScope solverScope) A timeGradient is a relative estimate of how long the search will continue.
boolean	isPhaseTerminated(AbstractSolverPhaseScope phaseScope) Called by the SolverPhase 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.
void	setMaximumTimeMillisSpend(long maximumTimeMillisSpend)

Methods inherited from class org.drools.planner.core.phase.event.SolverPhaseLifecycleListenerAdapter

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from class org.drools.planner.core.solver.event.SolverLifecycleListenerAdapter

solvingEnded, solvingStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.planner.core.phase.event.SolverPhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface org.drools.planner.core.solver.event.SolverLifecycleListener

solvingEnded, solvingStarted

Constructor Detail

TimeMillisSpendTermination

public TimeMillisSpendTermination()

Method Detail

setMaximumTimeMillisSpend

public void setMaximumTimeMillisSpend(long maximumTimeMillisSpend)

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(AbstractSolverPhaseScope phaseScope)

Description copied from interface: Termination

Called by the SolverPhase 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(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(AbstractSolverPhaseScope 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.