Iteration

java.lang.Object

org.opt4j.core.optimizer.Iteration

public class Iteration extends Object

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

Field Summary

Fields

Modifier and Type

Field

Description

protected final int

maxIterations

protected int

value
Constructor Summary

Constructors

Constructor

Description

Iteration(int maxIterations)

Constructs a Iteration object.
Method Summary

Modifier and Type

Method

Description

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 Details
- value
  
  protected int value
- maxIterations
  
  protected final int maxIterations
Constructor Details
- Iteration
  
  @Inject public Iteration(int maxIterations)
  
  Constructs a Iteration object.
  
  Parameters:
  
  maxIterations - the maximal number of iterations
Method Details
- 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