Package adams.opt.genetic.stopping

Class AbstractStoppingCriterion

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.opt.genetic.stopping.AbstractStoppingCriterion

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

MaxIterations, MaxIterationsWithoutImprovement, MaxTrainTime, MaxTrainTimeWithoutImprovement, MultiStoppingCriterion

public abstract class AbstractStoppingCriterion
extends AbstractOptionHandler

Ancestor for stopping criteria.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractStoppingCriterion()

Method Summary

Modifier and Type	Method	Description
protected void	check(AbstractGeneticAlgorithm genetic)	Hook method for checking the algorithm before attempting the actual stop check.
boolean	checkStopping(AbstractGeneticAlgorithm genetic)	Performs the check of the stopping criterion.
protected abstract boolean	doCheckStopping(AbstractGeneticAlgorithm genetic)	Performs the actual check of the stopping criterion.
abstract void	start()	Gets called when the genetic algorithm starts.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractStoppingCriterion

public AbstractStoppingCriterion()

Method Detail

start

public abstract void start()

Gets called when the genetic algorithm starts.

check

protected void check(AbstractGeneticAlgorithm genetic)

Hook method for checking the algorithm before attempting the actual stop check.
Default implementation only ensures that an algorithm was provided.

Parameters:

genetic - the algorithm to check

doCheckStopping

protected abstract boolean doCheckStopping(AbstractGeneticAlgorithm genetic)

Performs the actual check of the stopping criterion.

Parameters:

genetic - the algorithm

Returns:

true if to stop

checkStopping

public boolean checkStopping(AbstractGeneticAlgorithm genetic)

Performs the check of the stopping criterion.

Parameters:

genetic - the algorithm

Returns:

true if to stop