|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math3.util.IterationManager
public class IterationManager
This abstract class provides a general framework for managing iterative algorithms. The maximum number of iterations can be set, and methods are provided to monitor the current iteration count. A lightweight event framework is also provided.
| Constructor Summary | |
|---|---|
IterationManager(int maxIterations)
Creates a new instance of this class. |
|
IterationManager(int maxIterations,
Incrementor.MaxCountExceededCallback callBack)
Creates a new instance of this class. |
|
| Method Summary | |
|---|---|
void |
addIterationListener(IterationListener listener)
Attaches a listener to this manager. |
void |
fireInitializationEvent(IterationEvent e)
Informs all registered listeners that the initial phase (prior to the main iteration loop) has been completed. |
void |
fireIterationPerformedEvent(IterationEvent e)
Informs all registered listeners that a new iteration (in the main iteration loop) has been performed. |
void |
fireIterationStartedEvent(IterationEvent e)
Informs all registered listeners that a new iteration (in the main iteration loop) has been started. |
void |
fireTerminationEvent(IterationEvent e)
Informs all registered listeners that the final phase (post-iterations) has been completed. |
int |
getIterations()
Returns the number of iterations of this solver, 0 if no iterations has been performed yet. |
int |
getMaxIterations()
Returns the maximum number of iterations. |
void |
incrementIterationCount()
Increments the iteration count by one, and throws an exception if the maximum number of iterations is reached. |
void |
removeIterationListener(IterationListener listener)
Removes the specified iteration listener from the list of listeners currently attached to this object. |
void |
resetIterationCount()
Sets the iteration count to 0. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public IterationManager(int maxIterations)
maxIterations - the maximum number of iterations
public IterationManager(int maxIterations,
Incrementor.MaxCountExceededCallback callBack)
maxIterations - the maximum number of iterationscallBack - the function to be called when the maximum number of
iterations has been reached
NullArgumentException - if callBack is null| Method Detail |
|---|
public void addIterationListener(IterationListener listener)
listener - A IterationListener object.public void fireInitializationEvent(IterationEvent e)
e - The IterationEvent object.public void fireIterationPerformedEvent(IterationEvent e)
e - The IterationEvent object.public void fireIterationStartedEvent(IterationEvent e)
e - The IterationEvent object.public void fireTerminationEvent(IterationEvent e)
e - The IterationEvent object.public int getIterations()
public int getMaxIterations()
public void incrementIterationCount()
throws MaxCountExceededException
MaxCountExceededException - if the maximum number of iterations is
reached.public void removeIterationListener(IterationListener listener)
this object. Attempting to remove a
listener which was not previously registered does not cause any
error.
listener - The IterationListener to be removed.public void resetIterationCount()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||