org.apache.commons.math3.util
Class IterationEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.apache.commons.math3.util.IterationEvent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
IterativeLinearSolverEvent

public class IterationEvent
extends EventObject

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

Version:
$Id: IterationEvent.java 1416643 2012-12-03 19:37:14Z tn $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
IterationEvent(Object source, int iterations)
          Creates a new instance of this class.
 
Method Summary
 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IterationEvent

public IterationEvent(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


Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.