org.opt4j.core.start

Class Progress

java.lang.Object

org.opt4j.core.start.Progress

All Implemented Interfaces:

OptimizerIterationListener

public class Progress
extends java.lang.Object
implements OptimizerIterationListener

The Progress offers some methods for the measurement of the progress of an Optimizer.

See Also:

Optimizer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	iteration
protected java.lang.Integer	maxIterations

Constructor Summary

Constructors

Constructor and Description
Progress()

Method Summary

Modifier and Type	Method and Description
java.lang.Double	get() Returns the progress value between 0 and 1.
int	getCurrentIteration() Returns the current iteration.
java.lang.Integer	getMaxIterations() Returns the number of maximal iterations.
void	iterationComplete(int iteration) Invoked if the Optimizer completes an iteration.

Methods inherited from class java.lang.Object

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

Field Detail

maxIterations

@Inject(optional=true)
protected java.lang.Integer maxIterations

iteration

protected int iteration

Constructor Detail

Progress

public Progress()

Method Detail

get

public java.lang.Double get()

Returns the progress value between 0 and 1.

Returns:

the progress value

getMaxIterations

public java.lang.Integer getMaxIterations()

Returns the number of maximal iterations.

Returns:

the number of maximal iteration

getCurrentIteration

public int getCurrentIteration()

Returns the current iteration.

Returns:

the current iteration

iterationComplete

public void iterationComplete(int iteration)

Description copied from interface: OptimizerIterationListener

Invoked if the Optimizer completes an iteration.

Specified by:

iterationComplete in interface OptimizerIterationListener

Parameters:

iteration - the completed iteration