xal.extension.twissobserver

Interface CsFixedPtEstimator.IProgressListener

Enclosing class:

CsFixedPtEstimator

public static interface CsFixedPtEstimator.IProgressListener

Interface defining the methods to implement for a class that wishes to monitor the progress of solution computation.

Since:

Oct 2, 2014

Method Summary

Modifier and Type	Method and Description
void	iterationUpdate(int cntIter, double dblAlpha, double dblError) Notifies the listener of the residual error at the current iteration.
void	searchComplete(CovarianceMatrix matRecon) Signals the listener object that the search has terminated and provides the covariance matrix where the search stopped.

Method Detail

iterationUpdate

void iterationUpdate(int cntIter,
                     double dblAlpha,
                     double dblError)

Notifies the listener of the residual error at the current iteration. Thus, this method is fired at every iteration. Note that the tuning parameter α is dynamic, its value changes throughout the iteration based upon an algorithm for stabilizing the convergence.

Parameters:

cntIter - the current iteration count

dblError - the residual solution error at the current iteration

dblAlpha - the current tuning parameter value

Since:

Oct 2, 2014

searchComplete

void searchComplete(CovarianceMatrix matRecon)

Signals the listener object that the search has terminated and provides the covariance matrix where the search stopped. It is up to the listener to check the error tolerance and iteration count to determine whether or not the given covariance matrix is acceptable.

Parameters:

matRecon - the covariance matrix where the search ended.

Since:

Oct 23, 2014