gov.sandia.cognition.algorithm.event

Class IterationStartReporter

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.algorithm.event.AbstractIterativeAlgorithmListener

gov.sandia.cognition.algorithm.event.IterationStartReporter

All Implemented Interfaces:

IterativeAlgorithmListener, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class IterationStartReporter
extends AbstractIterativeAlgorithmListener

An iterative algorithm listener that reports the start of each iteration to the given print stream.

Since:

3.3.3

Author:

Justin Basilico

See Also:

IterativeAlgorithm, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FORMAT The default format is "Iteration %d".
protected java.lang.String	format The format for the performance report, passed to String.format.
protected java.io.PrintStream	out The print stream to report performance to.

Constructor Summary

Constructors

Constructor and Description
IterationStartReporter() Creates a new IterationStartReporter that reports to System.out using the default format.
IterationStartReporter(java.io.PrintStream out) Creates a new IterationStartReporter that reports to the given print stream using the default format.
IterationStartReporter(java.io.PrintStream out, java.lang.String format) Creates a new IterationStartReporter that reports to the given print stream and format.
IterationStartReporter(java.lang.String format) Creates a new IterationStartReporter that reports to System.out and the given format.

Method Summary

Modifier and Type	Method and Description
void	stepStarted(IterativeAlgorithm algorithm) This method is called when the algorithm has started a step in its execution.

Methods inherited from class gov.sandia.cognition.algorithm.event.AbstractIterativeAlgorithmListener

algorithmEnded, algorithmStarted, stepEnded

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT

public static final java.lang.String DEFAULT_FORMAT

The default format is "Iteration %d".

See Also:

Constant Field Values

out

protected java.io.PrintStream out

The print stream to report performance to.

format

protected java.lang.String format

The format for the performance report, passed to String.format.

Constructor Detail

IterationStartReporter

public IterationStartReporter()

Creates a new IterationStartReporter that reports to System.out using the default format.

IterationStartReporter

public IterationStartReporter(java.io.PrintStream out)

Creates a new IterationStartReporter that reports to the given print stream using the default format.

Parameters:

out - Print stream to report the status to.

IterationStartReporter

public IterationStartReporter(java.lang.String format)

Creates a new IterationStartReporter that reports to System.out and the given format.

Parameters:

format - Format string for the status messages, which passed to String.format.

IterationStartReporter

public IterationStartReporter(java.io.PrintStream out,
                              java.lang.String format)

Creates a new IterationStartReporter that reports to the given print stream and format.

Parameters:

out - Print stream to report the status to.

format - Format string for the status messages, which passed to String.format.

Method Detail

stepStarted

public void stepStarted(IterativeAlgorithm algorithm)

Description copied from interface: IterativeAlgorithmListener

This method is called when the algorithm has started a step in its execution.

Specified by:

stepStarted in interface IterativeAlgorithmListener

Overrides:

stepStarted in class AbstractIterativeAlgorithmListener

Parameters:

algorithm - The algorithm that has started another step of its execution.