cern.colt.matrix.tdouble.algo.solver

Class AbstractDoubleIterationMonitor

java.lang.Object

cern.colt.matrix.tdouble.algo.solver.AbstractDoubleIterationMonitor

All Implemented Interfaces:

DoubleIterationMonitor

Direct Known Subclasses:

DefaultDoubleIterationMonitor, HyBRDoubleIterationMonitor

public abstract class AbstractDoubleIterationMonitor
extends java.lang.Object
implements DoubleIterationMonitor

Partial implementation of an iteration reporter

Constructor Summary

Constructors

Constructor and Description
AbstractDoubleIterationMonitor() Constructor for AbstractIterationMonitor.

Method Summary

Modifier and Type	Method and Description
boolean	converged(double r) Checks for convergence
boolean	converged(double r, DoubleMatrix1D x) Checks for convergence
boolean	converged(DoubleMatrix1D r) Checks for convergence
boolean	converged(DoubleMatrix1D r, DoubleMatrix1D x) Checks for convergence
DoubleIterationReporter	getIterationReporter() Returns current iteration reporter
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
double	residual() Returns current residual
void	setFirst() Resets the iteration
void	setIterationReporter(DoubleIterationReporter monitor) Sets new iteration reporter
void	setNormType(Norm normType) Sets the vector-norm to calculate with

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cern.colt.matrix.tdouble.algo.solver.DoubleIterationMonitor

getMaxIterations, setMaxIterations

Constructor Detail

AbstractDoubleIterationMonitor

public AbstractDoubleIterationMonitor()

Constructor for AbstractIterationMonitor. Default norm is the 2-norm with no iteration reporting.

Method Detail

setFirst

public void setFirst()

Description copied from interface: DoubleIterationMonitor

Resets the iteration

Specified by:

setFirst in interface DoubleIterationMonitor

isFirst

public boolean isFirst()

Description copied from interface: DoubleIterationMonitor

Returns true for the first iteration

Specified by:

isFirst in interface DoubleIterationMonitor

next

public void next()

Description copied from interface: DoubleIterationMonitor

Increases iteration counter

Specified by:

next in interface DoubleIterationMonitor

iterations

public int iterations()

Description copied from interface: DoubleIterationMonitor

Number of iterations performed

Specified by:

iterations in interface DoubleIterationMonitor

converged

public boolean converged(DoubleMatrix1D r,
                         DoubleMatrix1D x)
                  throws IterativeSolverDoubleNotConvergedException

Description copied from interface: DoubleIterationMonitor

Checks for convergence

Specified by:

converged in interface DoubleIterationMonitor

Parameters:

r - Residual-vector

x - State-vector

Returns:

True if converged

Throws:

IterativeSolverDoubleNotConvergedException

converged

public boolean converged(double r,
                         DoubleMatrix1D x)
                  throws IterativeSolverDoubleNotConvergedException

Description copied from interface: DoubleIterationMonitor

Checks for convergence

Specified by:

converged in interface DoubleIterationMonitor

Parameters:

r - Residual-norm

x - State-vector

Returns:

True if converged

Throws:

IterativeSolverDoubleNotConvergedException

converged

public boolean converged(double r)
                  throws IterativeSolverDoubleNotConvergedException

Description copied from interface: DoubleIterationMonitor

Checks for convergence

Specified by:

converged in interface DoubleIterationMonitor

Parameters:

r - Residual-norm

Returns:

True if converged

Throws:

IterativeSolverDoubleNotConvergedException

converged

public boolean converged(DoubleMatrix1D r)
                  throws IterativeSolverDoubleNotConvergedException

Description copied from interface: DoubleIterationMonitor

Checks for convergence

Specified by:

converged in interface DoubleIterationMonitor

Parameters:

r - Residual-vector

Returns:

True if converged

Throws:

IterativeSolverDoubleNotConvergedException

getNormType

public Norm getNormType()

Description copied from interface: DoubleIterationMonitor

Returns the vector-norm in use

Specified by:

getNormType in interface DoubleIterationMonitor

setNormType

public void setNormType(Norm normType)

Description copied from interface: DoubleIterationMonitor

Sets the vector-norm to calculate with

Specified by:

setNormType in interface DoubleIterationMonitor

getIterationReporter

public DoubleIterationReporter getIterationReporter()

Description copied from interface: DoubleIterationMonitor

Returns current iteration reporter

Specified by:

getIterationReporter in interface DoubleIterationMonitor

setIterationReporter

public void setIterationReporter(DoubleIterationReporter monitor)

Description copied from interface: DoubleIterationMonitor

Sets new iteration reporter

Specified by:

setIterationReporter in interface DoubleIterationMonitor

residual

public double residual()

Description copied from interface: DoubleIterationMonitor

Returns current residual

Specified by:

residual in interface DoubleIterationMonitor