Apache Commons Math 3.6.1 · org.apache.commons.math3.util.IterationEvent

The root class from which all events occurring while running an IterationManager should be derived.

Field Summary

Modifier and Type	Field and Description
private final int	iterations The number of iterations performed so far.
private static final long	serialVersionUID Hides java.util.EventObject.serialVersionUID.

Access	Constructor and Description
public	IterationEvent(final Object the iterative algorithm on which the event initially occurred source, final int the number of iterations performed at the time `this` event is created iterations) Creates a new instance of this class.

Modifier and Type	Method and Description
public int	Returns: the number of iterations performed getIterations() Returns the number of iterations performed at the time `this` event is created.

iterations	back to summary
private final int iterations The number of iterations performed so far.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.EventObject.serialVersionUID.

IterationEvent back to summary

IterationEvent	back to summary
public IterationEvent(final Object source, final int iterations) Creates a new instance of this class. Parameters source:Object the iterative algorithm on which the event initially occurred iterations:int the number of iterations performed at the time `this` event is created

public IterationEvent(final Object source, final int iterations)

Creates a new instance of this class.

Parameters

source:Object: the iterative algorithm on which the event initially occurred
iterations:int: the number of iterations performed at the time this event is created

getIterations back to summary

getIterations	back to summary
public int getIterations() Returns the number of iterations performed at the time `this` event is created. Returns:int the number of iterations performed

public int getIterations()

Returns the number of iterations performed at the time this event is created.