org.apache.commons.math3.util

Class IterationEvent

java.lang.Object

java.util.EventObject

org.apache.commons.math3.util.IterationEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IterativeLinearSolverEvent

public class IterationEvent
extends java.util.EventObject

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IterationEvent(java.lang.Object source, int iterations) Creates a new instance of this class.

Method Summary

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

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IterationEvent

public IterationEvent(java.lang.Object source,
                      int iterations)

Creates a new instance of this class.

Parameters:

source - the iterative algorithm on which the event initially occurred

iterations - the number of iterations performed at the time this event is created

Method Detail

getIterations

public int getIterations()

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

Returns:

the number of iterations performed