Package org.hipparchus.util

Class IterationManager

  • public class IterationManager
extends Object
    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 Detail

      • IterationManager

        public IterationManager​(int maxIterations)
        Creates a new instance of this class.
        Parameters:
        maxIterations - the maximum number of iterations

      • IterationManager

        public IterationManager​(int maxIterations,
                        Incrementor.MaxCountExceededCallback callBack)
        Creates a new instance of this class.
        Parameters:
        maxIterations - the maximum number of iterations
        callBack - the function to be called when the maximum number of iterations has been reached
        Throws:
        NullArgumentException - if callBack is null

    • Method Detail

      • addIterationListener

        public void addIterationListener​(IterationListener listener)
        Attaches a listener to this manager.
        Parameters:
        listener - A IterationListener object.

      • fireInitializationEvent

        public void fireInitializationEvent​(IterationEvent e)
        Informs all registered listeners that the initial phase (prior to the main iteration loop) has been completed.
        Parameters:
        e - The IterationEvent object.

      • fireIterationPerformedEvent

        public void fireIterationPerformedEvent​(IterationEvent e)
        Informs all registered listeners that a new iteration (in the main iteration loop) has been performed.
        Parameters:
        e - The IterationEvent object.

      • fireIterationStartedEvent

        public void fireIterationStartedEvent​(IterationEvent e)
        Informs all registered listeners that a new iteration (in the main iteration loop) has been started.
        Parameters:
        e - The IterationEvent object.

      • fireTerminationEvent

        public void fireTerminationEvent​(IterationEvent e)
        Informs all registered listeners that the final phase (post-iterations) has been completed.
        Parameters:
        e - The IterationEvent object.

      • getIterations

        public int getIterations()
        Returns the number of iterations of this solver, 0 if no iterations has been performed yet.
        Returns:
        the number of iterations.

      • getMaxIterations

        public int getMaxIterations()
        Returns the maximum number of iterations.
        Returns:
        the maximum number of iterations.

      • incrementIterationCount

        public void incrementIterationCount()
                             throws MathIllegalStateException
        Increments the iteration count by one, and throws an exception if the maximum number of iterations is reached. This method should be called at the beginning of a new iteration.
        Throws:
        MathIllegalStateException - if the maximum number of iterations is reached.

      • removeIterationListener

        public void removeIterationListener​(IterationListener listener)
        Removes the specified iteration listener from the list of listeners currently attached to this object. Attempting to remove a listener which was not previously registered does not cause any error.
        Parameters:
        listener - The IterationListener to be removed.

      • resetIterationCount

        public void resetIterationCount()
        Sets the iteration count to 0. This method must be called during the initial phase.