org.jamesframework.core.search.stopcriteria

Class MaxTimeWithoutImprovement

java.lang.Object

org.jamesframework.core.search.stopcriteria.MaxTimeWithoutImprovement

All Implemented Interfaces:

StopCriterion

public class MaxTimeWithoutImprovement
extends Object
implements StopCriterion

Stop criterion that limits the time without finding any improvement during a search run.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
MaxTimeWithoutImprovement(long maxTimeWithoutImprovement, TimeUnit timeUnit) Create a stop criterion to limit the time without finding any improvement during a search run.

Method Summary

Modifier and Type	Method and Description
boolean	searchShouldStop(Search<?> search) Checks whether the maximum time without finding improvements has been reached for the given search.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxTimeWithoutImprovement

public MaxTimeWithoutImprovement(long maxTimeWithoutImprovement,
                                 TimeUnit timeUnit)

Create a stop criterion to limit the time without finding any improvement during a search run. The given time should be at least 1 millisecond.

Parameters:

maxTimeWithoutImprovement - maximum time without improvement

timeUnit - corresponding time unit

Throws:

IllegalArgumentException - if given time is smaller than 1 millisecond

Method Detail

searchShouldStop

public boolean searchShouldStop(Search<?> search)

Checks whether the maximum time without finding improvements has been reached for the given search.

Specified by:

searchShouldStop in interface StopCriterion

Parameters:

search - search for which the time without finding improvements has to be checked

Returns:

true if the given search has reached the maximum time without improvement

toString

public String toString()

Overrides:

toString in class Object