Package adams.opt.optimise

Class RefineRange

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.opt.optimise.AbstractOptimiser

adams.opt.optimise.RefineRange

All Implemented Interfaces:

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

public class RefineRange
extends AbstractOptimiser

Grid Search searches the parameter hyper-grid space. The search is refineable.

Valid options are:

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

-iterations <int> (property: iterations)
         The number of iterations to use.
         default: 1000
 

-grids <int> (property: grids)
         The number of grids to use.
         default: 3
 

Version:

$Revision$

Author:

dale

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractOptimiser	m_optimiser	optimiser.
protected int	m_Refinements	number of parameter refinements.

Fields inherited from class adams.opt.optimise.AbstractOptimiser

m_bestf, m_bestv

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

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
void	defineOptions()	Adds options to the internal list of options.
AbstractOptimiser	getOptimiser()	get optimiser.
int	getRefinements()	Gets the refinements use.
String	globalInfo()	Returns a string describing the object.
OptData	optimise(OptData datadef, FitnessFunction fitness)	Do Optimisation.
String	optimiserTipText()	Returns the tip text for this property.
String	refinementsTipText()	Returns the tip text for this property.
void	reset()	Resets the optimizer.
void	setOptimiser(AbstractOptimiser ao)	Set optimiser to use.
void	setRefinements(int value)	Sets the refinements to use.

Methods inherited from class adams.opt.optimise.AbstractOptimiser

checkBest, compareTo, destroy, equals, forCommandLine, forName, getOptimisers, initialize, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Refinements

protected int m_Refinements

number of parameter refinements.

m_optimiser

protected AbstractOptimiser m_optimiser

optimiser.

Constructor Detail

RefineRange

public RefineRange()

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

reset

public void reset()

Description copied from class: AbstractOptimiser

Resets the optimizer.

Overrides:

reset in class AbstractOptimiser

setOptimiser

public void setOptimiser(AbstractOptimiser ao)

Set optimiser to use.

Parameters:

ao - optimiser.

getOptimiser

public AbstractOptimiser getOptimiser()

get optimiser.

Returns:

optimiser.

optimiserTipText

public String optimiserTipText()

Returns the tip text for this property.

Returns:

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

setRefinements

public void setRefinements(int value)

Sets the refinements to use.

Parameters:

value - the num.

getRefinements

public int getRefinements()

Gets the refinements use.

Returns:

the number

refinementsTipText

public String refinementsTipText()

Returns the tip text for this property.

Returns:

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

optimise

public OptData optimise(OptData datadef,
                        FitnessFunction fitness)

Do Optimisation.

Specified by:

optimise in class AbstractOptimiser

Parameters:

datadef - the vars

fitness - fitness function

Returns:

best vars

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractOptimiser