gov.sandia.cognition.algorithm
Interface IterativeAlgorithmListener

All Known Implementing Classes:
AbstractIterativeAlgorithmListener, AbstractMinimizerBasedParameterCostMinimizer, AnytimeAlgorithmWrapper, DirichletProcessClustering, DistributionParameterEstimator, GaussianContextRecognizer.Learner, IterationMeasurablePerformanceReporter, IterationStartReporter, IVotingCategorizerLearner.OutOfBagErrorStoppingCriteria, MinimizerBasedRootFinder, MixtureOfGaussians.Learner, ParameterDerivativeFreeCostMinimizer, ParameterDifferentiableCostMinimizer, ProbabilisticLatentSemanticAnalysis.StatusPrinter

@CodeReviews(reviews={@CodeReview(reviewer="Kevin R. Dixon",date="2008-02-08",changesNeeded=false,comments="Class looks fine."),@CodeReview(reviewer="Justin Basilico",date="2006-10-02",changesNeeded=false,comments="Interface is fine.")})
public interface IterativeAlgorithmListener

The IterativeAlgorithmListener interface defines the events that are generated by an IterativeAlgorithm. Events exist for the beginning/end of the algorithm and the beginning/end of each step of the iterative algorithm.

Since:
2.0
Author:
Justin Basilico
See Also:
IterativeAlgorithm

Method Summary
 void algorithmEnded(IterativeAlgorithm algorithm)
          This method is called when the algorithm has ended, after the last step of the algorithm.
 void algorithmStarted(IterativeAlgorithm algorithm)
          This method is called when a algorithm has started, before the first step of the algorithm.
 void stepEnded(IterativeAlgorithm algorithm)
          This method is called when the algorithm has ended a step of its execution.
 void stepStarted(IterativeAlgorithm algorithm)
          This method is called when the algorithm has started a step in its execution.
 

Method Detail

algorithmStarted

void algorithmStarted(IterativeAlgorithm algorithm)
This method is called when a algorithm has started, before the first step of the algorithm.

Parameters:
algorithm - The algorithm that has started.

algorithmEnded

void algorithmEnded(IterativeAlgorithm algorithm)
This method is called when the algorithm has ended, after the last step of the algorithm.

Parameters:
algorithm - The algorithm that has ended.

stepStarted

void stepStarted(IterativeAlgorithm algorithm)
This method is called when the algorithm has started a step in its execution.

Parameters:
algorithm - The algorithm that has started another step of its execution.

stepEnded

void stepEnded(IterativeAlgorithm algorithm)
This method is called when the algorithm has ended a step of its execution.

Parameters:
algorithm - The algorithm that has ended another step of its execution.