Package com.graphhopper.jsprit.core.algorithm.termination

Class TimeTermination

java.lang.Object

com.graphhopper.jsprit.core.algorithm.termination.TimeTermination

All Implemented Interfaces:

AlgorithmStartsListener, VehicleRoutingAlgorithmListener, PrematureAlgorithmTermination

public class TimeTermination
extends Object
implements PrematureAlgorithmTermination, AlgorithmStartsListener

Terminates algorithm prematurely based on specified time.

Note, TimeTermination must be registered as AlgorithmListener
TimeTermination will be activated by:

algorithm.setPrematureAlgorithmTermination(this);
algorithm.addListener(this);

Author:

stefan schroeder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimeTermination.TimeGetter

Constructor Summary

Constructors

Constructor	Description
TimeTermination(long timeThreshold_in_milliseconds)	Constructs TimeTermination that terminates algorithm prematurely based on specified time.

Method Summary

Modifier and Type	Method	Description
long	getRemainingTime()
long	getStartTime()
void	informAlgorithmStarts(VehicleRoutingProblem problem, VehicleRoutingAlgorithm algorithm, Collection<VehicleRoutingProblemSolution> solutions)
boolean	isPrematureBreak(SearchStrategy.DiscoveredSolution discoveredSolution)	Returns true if algorithm should terminate, false otherwise.
long	now()
void	setTimeGetter(TimeTermination.TimeGetter timeGetter)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TimeTermination

public TimeTermination(long timeThreshold_in_milliseconds)

Constructs TimeTermination that terminates algorithm prematurely based on specified time.

Parameters:

timeThreshold_in_milliseconds - the computation time [in ms] after which the algorithm terminates

Method Details

setTimeGetter

public void setTimeGetter(TimeTermination.TimeGetter timeGetter)

toString

public String toString()

Overrides:

toString in class Object

isPrematureBreak

public boolean isPrematureBreak(SearchStrategy.DiscoveredSolution discoveredSolution)

Description copied from interface: PrematureAlgorithmTermination

Returns true if algorithm should terminate, false otherwise.

Specified by:

isPrematureBreak in interface PrematureAlgorithmTermination

Parameters:

discoveredSolution - the discovered solution

Returns:

true if algorithm should terminate, false otherwise

now

public long now()

informAlgorithmStarts

public void informAlgorithmStarts(VehicleRoutingProblem problem,
 VehicleRoutingAlgorithm algorithm,
 Collection<VehicleRoutingProblemSolution> solutions)

Specified by:

informAlgorithmStarts in interface AlgorithmStartsListener

getRemainingTime

public long getRemainingTime()

getStartTime

public long getStartTime()