org.opt4j.common.logger

Class TsvLogger

java.lang.Object

org.opt4j.common.logger.AbstractLogger

org.opt4j.common.logger.TsvLogger

All Implemented Interfaces:

Logger, IndividualStateListener, OptimizerIterationListener, OptimizerStateListener

public class TsvLogger
extends AbstractLogger
implements Logger

The TsvLogger writes all Individuals from the Archive to the specified file. It can be configured to write the data each iterationStep iterations or each evaluationStep evaluations. The file format is TSV (tab separated values), according to the Definition of tab-separated-values (tsv) by IANA.

Author:

reimann, lukasiewycz

Constructor Summary

Constructors

Constructor and Description
TsvLogger(Archive archive, String filename, int evaluationStep, int iterationStep) Creates an TsvLogger.

Method Summary

Modifier and Type	Method and Description
void	logEvent(int iteration, int evaluation) Callback method called if the specific number of iterations or evaluations is reached.
void	logHeader(Collection<Objective> objectives) Writes the header.
void	optimizationStarted() Callback method invoked once the optimization starts.
void	optimizationStopped() Callback method invoked once the optimization stops.

Methods inherited from class org.opt4j.common.logger.AbstractLogger

inidividualStateChanged, iterationComplete, optimizationStarted, optimizationStopped

Methods inherited from class java.lang.Object

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

Constructor Detail

TsvLogger

@Inject
public TsvLogger(Archive archive,
                         String filename,
                         int evaluationStep,
                         int iterationStep)

Creates an TsvLogger.

Parameters:

archive - the archive

filename - the filename (using namespace TsvLogger)

evaluationStep - the number of evaluations between two logging events (using namespace TsvLogger)

iterationStep - the number of iterations between two logging events (using namespace TsvLogger)

Method Detail

optimizationStarted

public void optimizationStarted()

Description copied from class: AbstractLogger

Callback method invoked once the optimization starts.

Specified by:

optimizationStarted in class AbstractLogger

logEvent

public void logEvent(int iteration,
                     int evaluation)

Description copied from class: AbstractLogger

Callback method called if the specific number of iterations or evaluations is reached.

Specified by:

logEvent in class AbstractLogger

Parameters:

iteration - the current iteration number

evaluation - the current evaluation number

optimizationStopped

public void optimizationStopped()

Description copied from class: AbstractLogger

Callback method invoked once the optimization stops.

Specified by:

optimizationStopped in class AbstractLogger

logHeader

public void logHeader(Collection<Objective> objectives)

Description copied from class: AbstractLogger

Writes the header.

Specified by:

logHeader in class AbstractLogger

Parameters:

objectives - a collection of objectives