org.opt4j.core.optimizer
Class Iteration

java.lang.Object
  org.opt4j.core.optimizer.Iteration

public class Iteration
extends java.lang.Object

The Iteration object is used as iteration counter for the optimization.

Field Summary

protected int	maxIterations
protected int	value

Constructor Summary

Iteration(int maxIterations)
Constructs a Iteration object.

Method Summary

int	max() Returns the maximal number of iterations.
void	next() Increases the iteration value by 1.
int	value() Returns the current iteration value.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected int value

maxIterations

protected final int maxIterations

Constructor Detail

Iteration

@Inject
public Iteration(int maxIterations)

Constructs a Iteration object.

Parameters:

maxIterations - the maximal number of iterations

Method Detail

value

public int value()

Returns the current iteration value.

Returns:

the current iteration value

next

public void next()

Increases the iteration value by 1.

max

public int max()

Returns the maximal number of iterations.

Returns:

the maximal number of iterations