Package adams.opt.genetic.stopping

Class MaxIterations

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.opt.genetic.stopping.AbstractStoppingCriterion

adams.opt.genetic.stopping.MaxIterations

All Implemented Interfaces:

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

public class MaxIterations
extends AbstractStoppingCriterion

Stops after the maximum number of iterations have been reached.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-num-iter <int> (property: numIterations)
    The number of iterations to perform.
    default: 10000000
    minimum: 1
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumIterations	number of iterations to perform.

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
MaxIterations()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doCheckStopping(AbstractGeneticAlgorithm genetic)	Performs the actual check of the stopping criterion.
int	getNumIterations()	Returns the number of iterations to perform.
String	globalInfo()	Returns a string describing the object.
String	numIterationsTipText()	Returns the tip text for this property.
void	setNumIterations(int value)	Sets the number of iterations to perform.
void	start()	Gets called when the genetic algorithm starts.

Methods inherited from class adams.opt.genetic.stopping.AbstractStoppingCriterion

check, checkStopping

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Field Detail

m_NumIterations

protected int m_NumIterations

number of iterations to perform.

Constructor Detail

MaxIterations

public MaxIterations()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setNumIterations

public void setNumIterations(int value)

Sets the number of iterations to perform.

Parameters:

value - the number

getNumIterations

public int getNumIterations()

Returns the number of iterations to perform.

Returns:

the number

numIterationsTipText

public String numIterationsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

start

public void start()

Gets called when the genetic algorithm starts.

Specified by:

start in class AbstractStoppingCriterion

doCheckStopping

protected boolean doCheckStopping(AbstractGeneticAlgorithm genetic)

Performs the actual check of the stopping criterion.

Specified by:

doCheckStopping in class AbstractStoppingCriterion

Parameters:

genetic - the algorithm

Returns:

true if to stop