org.jamesframework.core.search.stopcriteria

Class MaxStepsWithoutImprovement

java.lang.Object

org.jamesframework.core.search.stopcriteria.MaxStepsWithoutImprovement

All Implemented Interfaces:

StopCriterion

public class MaxStepsWithoutImprovement
extends Object
implements StopCriterion

Stop criterion that limits the number of steps without finding any improvement during a search run.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
MaxStepsWithoutImprovement(long maxStepsWithoutImprovement) Create a stop criterion to limit the number of steps without finding any improvement during a search run.

Method Summary

Modifier and Type	Method and Description
boolean	searchShouldStop(Search<?> search) Checks whether the maximum number of steps without finding improvement 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

MaxStepsWithoutImprovement

public MaxStepsWithoutImprovement(long maxStepsWithoutImprovement)

Create a stop criterion to limit the number of steps without finding any improvement during a search run. The given number of steps should be strictly positive.

Parameters:

maxStepsWithoutImprovement - maximum number of steps without improvement

Throws:

IllegalArgumentException - if maxStepsWithoutImprovement is ≤ 0

Method Detail

searchShouldStop

public boolean searchShouldStop(Search<?> search)

Checks whether the maximum number of steps without finding improvement has been reached for the given search.

Specified by:

searchShouldStop in interface StopCriterion

Parameters:

search - search for which the number of performed steps without finding any improvement has to be checked

Returns:

true if the given search has reached the maximum number of steps without improvement

toString

public String toString()

Overrides:

toString in class Object