loggers.defined

Class AcceptanceLogger

java.lang.Object

loggers.ManualLogger

loggers.defined.AcceptanceLogger

public class AcceptanceLogger
extends ManualLogger

Acceptance is a logger which keeps track of the success of the changes to the network in a single re-ranking. I.e. it logs the annealing process. It is also responsible to advice the re-ranking at set times if the annealing parameters are set well. At desired intervals, it will also print out characteristics of the annealing process to file.

Since:

0.0

Version:

1.0

Author:

Joeri Ruyssinck (joeri.ruysssinck@intec.ugent.be)

Constructor Summary

Constructors

Constructor and Description
AcceptanceLogger(int iterations, java.lang.String logFile, java.io.File outputDir, int granularity, boolean tempMaxSetting, double tempTargetGoal, double tempTargetAllowedDeviation, int tempIterationCheck) Constructs a new Acceptancelogger with given parameters.

Method Summary

Modifier and Type	Method and Description
void	advice(EnsembleSA sa) Overrides and defines the advice function for an Acceptance logger.
int	getAccepted()
java.util.ArrayList<java.lang.Double>	getAcceptedList()
int	getBetter()
java.util.ArrayList<java.lang.Double>	getBetterList()
java.util.ArrayList<java.lang.Double>	getChance()
int	getGranularity()
int	getLogged()
int	getReverted()
java.util.ArrayList<java.lang.Double>	getRevertedList()
int	getTempIterationCheck()
double	getTempTargetGoal()
double	getTempTargetGoalAllowedDeviation()
boolean	isTempGood()
boolean	isTempMaxSetting()
boolean	isTempToHigh()
boolean	isTempToLow()
ManualLogger	makeCopy(java.lang.String suffix) Copy constructor, creates and returns a new AcceptanceLogger in the form of a ManuaLogger, with the same settings as the argument but a different logfile.
void	setAccepted(int accepted)
void	setAcceptedList(java.util.ArrayList<java.lang.Double> acceptedList)
void	setBetter(int better)
void	setBetterList(java.util.ArrayList<java.lang.Double> betterList)
void	setChance(java.util.ArrayList<java.lang.Double> chance)
void	setGranularity(int granularity)
void	setLogged(int logged)
void	setReverted(int reverted)
void	setRevertedList(java.util.ArrayList<java.lang.Double> revertedList)
void	setTempGood(boolean tempGood)
void	setTempIterationCheck(int tempIterationCheck)
void	setTempMaxSetting(boolean tempMaxSetting)
void	setTempTargetGoal(double tempTargetGoal)
void	setTempTargetGoalAllowedDeviation(double tempTargetGoalAllowedDeviation)
void	setTempToHigh(boolean tempToHigh)
void	setTempToLow(boolean tempToLow)

Methods inherited from class loggers.ManualLogger

deleteFile, getIterations, getIterationsSoFar, getLogFile, isFired, isPositive, log, setFired, setLogFile, setPositive, toFile

Methods inherited from class java.lang.Object

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

Constructor Detail

AcceptanceLogger

public AcceptanceLogger(int iterations,
                        java.lang.String logFile,
                        java.io.File outputDir,
                        int granularity,
                        boolean tempMaxSetting,
                        double tempTargetGoal,
                        double tempTargetAllowedDeviation,
                        int tempIterationCheck)

Constructs a new Acceptancelogger with given parameters.

Parameters:

iterations - frequency of logging, passed to super constructor, for this penalty, should be 1

logFile - file to log too

outputDir - output directory

granularity - frequency of writing to file

tempMaxSetting - if temperature scheme should be checked by logger

tempTargetGoal - percentage goal for temperature scheme

tempTargetAllowedDeviation - allowed deviation from the goal

tempIterationCheck - after how many iterations should temperature scheme be checked

Method Detail

makeCopy

public ManualLogger makeCopy(java.lang.String suffix)

Copy constructor, creates and returns a new AcceptanceLogger in the form of a ManuaLogger, with the same settings as the argument but a different logfile.

Specified by:

makeCopy in class ManualLogger

Parameters:

suffix - new output filename

advice

public void advice(EnsembleSA sa)

Overrides and defines the advice function for an Acceptance logger. Re-ranking process agrees it needs to be changed and requests advice. This class will lower or increase the temperature settings.

Specified by:

advice in class ManualLogger

Parameters:

sa - the re-ranking progress requesting advice

isTempGood

public boolean isTempGood()

setTempGood

public void setTempGood(boolean tempGood)

getBetter

public int getBetter()

setBetter

public void setBetter(int better)

getAccepted

public int getAccepted()

setAccepted

public void setAccepted(int accepted)

getReverted

public int getReverted()

setReverted

public void setReverted(int reverted)

getLogged

public int getLogged()

setLogged

public void setLogged(int logged)

getChance

public java.util.ArrayList<java.lang.Double> getChance()

setChance

public void setChance(java.util.ArrayList<java.lang.Double> chance)

getBetterList

public java.util.ArrayList<java.lang.Double> getBetterList()

setBetterList

public void setBetterList(java.util.ArrayList<java.lang.Double> betterList)

getAcceptedList

public java.util.ArrayList<java.lang.Double> getAcceptedList()

setAcceptedList

public void setAcceptedList(java.util.ArrayList<java.lang.Double> acceptedList)

getRevertedList

public java.util.ArrayList<java.lang.Double> getRevertedList()

setRevertedList

public void setRevertedList(java.util.ArrayList<java.lang.Double> revertedList)

getGranularity

public int getGranularity()

setGranularity

public void setGranularity(int granularity)

isTempMaxSetting

public boolean isTempMaxSetting()

setTempMaxSetting

public void setTempMaxSetting(boolean tempMaxSetting)

getTempIterationCheck

public int getTempIterationCheck()

setTempIterationCheck

public void setTempIterationCheck(int tempIterationCheck)

getTempTargetGoal

public double getTempTargetGoal()

setTempTargetGoal

public void setTempTargetGoal(double tempTargetGoal)

getTempTargetGoalAllowedDeviation

public double getTempTargetGoalAllowedDeviation()

setTempTargetGoalAllowedDeviation

public void setTempTargetGoalAllowedDeviation(double tempTargetGoalAllowedDeviation)

isTempToHigh

public boolean isTempToHigh()

setTempToHigh

public void setTempToHigh(boolean tempToHigh)

isTempToLow

public boolean isTempToLow()

setTempToLow

public void setTempToLow(boolean tempToLow)