cern.colt.matrix.tfloat.algo.solver

Interface FloatIterationMonitor

All Known Implementing Classes:

AbstractFloatIterationMonitor, CGLSFloatIterationMonitor, DefaultFloatIterationMonitor, HyBRFloatIterationMonitor, MRNSDFloatIterationMonitor

public interface FloatIterationMonitor

Monitors the iterative solution process for convergence and divergence. Can also report the current progress.

Method Summary

Modifier and Type	Method and Description
boolean	converged(float r) Checks for convergence
boolean	converged(float r, FloatMatrix1D x) Checks for convergence
boolean	converged(FloatMatrix1D r) Checks for convergence
boolean	converged(FloatMatrix1D r, FloatMatrix1D x) Checks for convergence
FloatIterationReporter	getIterationReporter() Returns current iteration reporter
int	getMaxIterations() Returns the maximum number of iterations
Norm	getNormType() Returns the vector-norm in use
boolean	isFirst() Returns true for the first iteration
int	iterations() Number of iterations performed
void	next() Increases iteration counter
float	residual() Returns current residual
void	setFirst() Resets the iteration
void	setIterationReporter(FloatIterationReporter monitor) Sets new iteration reporter
void	setMaxIterations(int maxIter) Sets maximum number of iterations to permit
void	setNormType(Norm normType) Sets the vector-norm to calculate with

Method Detail

setFirst

void setFirst()

Resets the iteration

isFirst

boolean isFirst()

Returns true for the first iteration

next

void next()

Increases iteration counter

iterations

int iterations()

Number of iterations performed

residual

float residual()

Returns current residual

converged

boolean converged(FloatMatrix1D r,
                  FloatMatrix1D x)
           throws IterativeSolverFloatNotConvergedException

Checks for convergence

Parameters:

r - Residual-vector

x - State-vector

Returns:

True if converged

Throws:

IterativeSolverFloatNotConvergedException

converged

boolean converged(float r,
                  FloatMatrix1D x)
           throws IterativeSolverFloatNotConvergedException

Checks for convergence

Parameters:

r - Residual-norm

x - State-vector

Returns:

True if converged

Throws:

IterativeSolverFloatNotConvergedException

converged

boolean converged(float r)
           throws IterativeSolverFloatNotConvergedException

Checks for convergence

Parameters:

r - Residual-norm

Returns:

True if converged

Throws:

IterativeSolverFloatNotConvergedException

converged

boolean converged(FloatMatrix1D r)
           throws IterativeSolverFloatNotConvergedException

Checks for convergence

Parameters:

r - Residual-vector

Returns:

True if converged

Throws:

IterativeSolverFloatNotConvergedException

setIterationReporter

void setIterationReporter(FloatIterationReporter monitor)

Sets new iteration reporter

getIterationReporter

FloatIterationReporter getIterationReporter()

Returns current iteration reporter

setNormType

void setNormType(Norm normType)

Sets the vector-norm to calculate with

getNormType

Norm getNormType()

Returns the vector-norm in use

setMaxIterations

void setMaxIterations(int maxIter)

Sets maximum number of iterations to permit

Parameters:

maxIter - Maximum number of iterations

getMaxIterations

int getMaxIterations()

Returns the maximum number of iterations