core

Class AbstractMethod

java.lang.Object

core.AbstractComponent

core.AbstractMethod

Direct Known Subclasses:

NNGA, SSEA2D

public abstract class AbstractMethod
extends AbstractComponent

Abstract superclass for Method components. Methods are used to iteratively optimize a given set of AbstractRepresentations. They implement the Runnable interface meaning the algorithm will be executed on a separate thread.

Methods can save obtained results any time by calling the FrevoMain#saveResult(String, AbstractMethod) static method.

Author:

Istvan Fehervari

Constructor Summary

Constructors

Constructor and Description
AbstractMethod(NESRandom random)

Method Summary

Methods

Modifier and Type	Method and Description
float	getProgress() Returns the current progress of this method mostly for display purposes.
NESRandom	getRandom() Returns the assigned random generator object of this method.
long	getSeed() Returns the current random seed associated with the random object of this method.
abstract java.util.ArrayList<java.util.ArrayList<AbstractRepresentation>>	loadFromXML(org.dom4j.Document doc) Returns a 2D array of representations from the given XML result file.
void	pause() Sends an interrupt flag to the method.
abstract void	runOptimization(ProblemXMLData problemData, ComponentXMLData representationData, ComponentXMLData rankingData, java.util.Hashtable<java.lang.String,XMLFieldEntry> properties)
static void	setProgress(float p) Sets the progress of this method the given value.
void	setRandom(long seed) Sets the random seed for this method.
void	setRandom(NESRandom generator) Sets the random generator object to the given value.
void	wakeUp()

Methods inherited from class core.AbstractComponent

getProperties, getPropertyValue, getTypeOfProperty, getXMLData, setProperties, setXMLData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMethod

public AbstractMethod(NESRandom random)

Method Detail

pause

public final void pause()

Sends an interrupt flag to the method.

wakeUp

public final void wakeUp()

runOptimization

public abstract void runOptimization(ProblemXMLData problemData,
                   ComponentXMLData representationData,
                   ComponentXMLData rankingData,
                   java.util.Hashtable<java.lang.String,XMLFieldEntry> properties)

getProgress

public final float getProgress()

Returns the current progress of this method mostly for display purposes.

Returns:

a float value between 0 and 1

setProgress

public static final void setProgress(float p)

Sets the progress of this method the given value. This value is used by the assigned worker thread mostly for display purposed.

Parameters:

p - The new progress value to be used.

getRandom

public final NESRandom getRandom()

Returns the assigned random generator object of this method.

Returns:

a reference of the assigned random generator object.

setRandom

public final void setRandom(NESRandom generator)

Sets the random generator object to the given value.

Parameters:

generator - The new random generator object to be used.

setRandom

public final void setRandom(long seed)

Sets the random seed for this method.

Parameters:

seed - The new random seed to be used.

getSeed

public final long getSeed()

Returns the current random seed associated with the random object of this method.

Returns:

the current random seed of this method.

loadFromXML

public abstract java.util.ArrayList<java.util.ArrayList<AbstractRepresentation>> loadFromXML(org.dom4j.Document doc)

Returns a 2D array of representations from the given XML result file. This is mostly used for visual representations.

If the loading takes considerable amount of time it is advised to provide visual feedback to the user. This can be done by calling the FrevoMain.setLoadingProgress(float) method.

Parameters:

doc - The source Document to be used for loading the representations.

Returns:

A 2D array of AbstractRepresentations loaded from the source document.