Package adams.opt.genetic.stopping
Class MaxTrainTimeWithoutImprovement
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.opt.genetic.stopping.AbstractStoppingCriterion
-
- adams.opt.genetic.stopping.MaxTrainTimeWithoutImprovement
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,Serializable
public class MaxTrainTimeWithoutImprovement extends AbstractStoppingCriterion
Stops after the maximum number of seconds since last improvement has 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
-max-train <int> (property: maxTrainTime) The maximum number of seconds of training time to wait for improvement ( 0 = unlimited time). default: 0 minimum: 0
-min-improvement <double> (property: minimumImprovement) The minimum improvement in percent (0-1) to achieve in the alotted time. default: 0.0 minimum: 0.0 maximum: 1.0
- Version:
- $Revision$
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Double
m_LastFitness
the last fitness.protected int
m_MaxTrainTime
the maximum number of seconds to train.protected double
m_MinimumImprovement
the minimum required improvement (percent: 0-1).protected long
m_TrainStart
the time of last improvement.-
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 MaxTrainTimeWithoutImprovement()
-
Method Summary
All Methods Instance Methods Concrete Methods 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
getMaxTrainTime()
Returns the maximum number of seconds to wait for improvement.double
getMinimumImprovement()
Returns the minimum improvement in percent (0-1) to achieve in the alotted time.String
globalInfo()
Returns a string describing the object.String
maxTrainTimeTipText()
Returns the tip text for this property.String
minimumImprovementTipText()
Returns the tip text for this property.protected void
record(AbstractGeneticAlgorithm genetic)
Records time and fitness.protected void
reset()
Resets the scheme.void
setMaxTrainTime(int value)
Sets the maximum number of seconds to wait for improvement.void
setMinimumImprovement(double value)
Sets the minimum improvement in percent (0-1) to achieve in the alotted time.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, 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_MaxTrainTime
protected int m_MaxTrainTime
the maximum number of seconds to train.
-
m_MinimumImprovement
protected double m_MinimumImprovement
the minimum required improvement (percent: 0-1).
-
m_TrainStart
protected long m_TrainStart
the time of last improvement.
-
m_LastFitness
protected Double m_LastFitness
the last fitness.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
reset
protected void reset()
Resets the scheme.- Overrides:
reset
in classAbstractOptionHandler
-
setMaxTrainTime
public void setMaxTrainTime(int value)
Sets the maximum number of seconds to wait for improvement.- Parameters:
value
- the number of seconds
-
getMaxTrainTime
public int getMaxTrainTime()
Returns the maximum number of seconds to wait for improvement.- Returns:
- the number of seconds
-
maxTrainTimeTipText
public String maxTrainTimeTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setMinimumImprovement
public void setMinimumImprovement(double value)
Sets the minimum improvement in percent (0-1) to achieve in the alotted time.- Parameters:
value
- the minimum
-
getMinimumImprovement
public double getMinimumImprovement()
Returns the minimum improvement in percent (0-1) to achieve in the alotted time.- Returns:
- the minimum
-
minimumImprovementTipText
public String minimumImprovementTipText()
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 classAbstractStoppingCriterion
-
record
protected void record(AbstractGeneticAlgorithm genetic)
Records time and fitness.- Parameters:
genetic
- the algorithm
-
doCheckStopping
protected boolean doCheckStopping(AbstractGeneticAlgorithm genetic)
Performs the actual check of the stopping criterion.- Specified by:
doCheckStopping
in classAbstractStoppingCriterion
- Parameters:
genetic
- the algorithm- Returns:
- true if to stop
-
-