Progress

java.lang.Object
- org.opt4j.viewer.Progress

All Implemented Interfaces:

OptimizerIterationListener
```
public class Progress
extends 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 Description

protected int iteration

protected Integer maxIterations

Constructor Summary

Constructors
Constructor Description

Progress()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Double`	`get()`	Returns the progress value between `0` and `1`.
`int`	`getCurrentIteration()`	Returns the current iteration.
`Integer`	`getMaxIterations()`	Returns the number of maximal iterations.
`void`	`iterationComplete(Optimizer optimizer, 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 Integer maxIterations
```
  - iteration
```
protected int iteration
```
- Constructor Detail
  - Progress
```
public Progress()
```
- Method Detail
  - get
```
public Double get()
```
    Returns the progress value between 0 and 1.
    
    Returns:
    
    the progress value
  - getMaxIterations
```
public 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(Optimizer optimizer,
                              int iteration)
```
    Description copied from interface: OptimizerIterationListener
    
    Invoked if the Optimizer completes an iteration.
    
    Specified by:
    
    iterationComplete in interface OptimizerIterationListener
    
    Parameters:
    
    optimizer - the optimizer
    
    iteration - the completed iteration