Package adams.opt.genetic.stopping

Class MultiStoppingCriterion

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.opt.genetic.stopping.AbstractStoppingCriterion

adams.opt.genetic.stopping.MultiStoppingCriterion

All Implemented Interfaces:

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

public class MultiStoppingCriterion
extends AbstractStoppingCriterion

Applies its sub-criteria, one after the other.

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

-criterion <adams.genetic.stopping.AbstractStoppingCriterion> [-criterion ...] (property: criteria)
    The criteria to apply, one after the other.
    default: 
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractStoppingCriterion[]	m_Criteria	the criteria to use.

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

Method Summary

Modifier and Type	Method	Description
String	criteriaTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doCheckStopping(AbstractGeneticAlgorithm genetic)	Performs the actual check of the stopping criterion.
AbstractStoppingCriterion[]	getCriteria()	Returns the criteria in use.
String	globalInfo()	Returns a string describing the object.
void	setCriteria(AbstractStoppingCriterion[] value)	Sets the criteria to use.
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_Criteria

protected AbstractStoppingCriterion[] m_Criteria

the criteria to use.

Constructor Detail

MultiStoppingCriterion

public MultiStoppingCriterion()

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

setCriteria

public void setCriteria(AbstractStoppingCriterion[] value)

Sets the criteria to use.

Parameters:

value - the criteria

getCriteria

public AbstractStoppingCriterion[] getCriteria()

Returns the criteria in use.

Returns:

the criteria

criteriaTipText

public String criteriaTipText()

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