Package no.uib.cipr.matrix.sparse
Class AbstractIterationMonitor
java.lang.Object
no.uib.cipr.matrix.sparse.AbstractIterationMonitor
- All Implemented Interfaces:
IterationMonitor
- Direct Known Subclasses:
DefaultIterationMonitor
Partial implementation of an iteration reporter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
Iteration numberprotected Vector.Norm
Vector-normprotected IterationReporter
Iteration reporterprotected double
Current residual -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
converged
(double r) Checks for convergenceboolean
Checks for convergenceboolean
Checks for convergenceboolean
Checks for convergenceprotected abstract boolean
convergedI
(double r) protected abstract boolean
convergedI
(double r, Vector x) Returns current iteration reporterReturns the vector-norm in useboolean
isFirst()
Returns true for the first iterationint
Number of iterations performedvoid
next()
Increases iteration counterdouble
residual()
Returns current residualvoid
setFirst()
Resets the iterationvoid
setIterationReporter
(IterationReporter monitor) Sets new iteration reportervoid
setNormType
(Vector.Norm normType) Sets the vector-norm to calculate with
-
Field Details
-
iter
protected int iterIteration number -
normType
Vector-norm -
reporter
Iteration reporter -
residual
protected double residualCurrent residual
-
-
Constructor Details
-
AbstractIterationMonitor
public AbstractIterationMonitor()Constructor for AbstractIterationMonitor. Default norm is the 2-norm with no iteration reporting.
-
-
Method Details
-
setFirst
public void setFirst()Description copied from interface:IterationMonitor
Resets the iteration- Specified by:
setFirst
in interfaceIterationMonitor
-
isFirst
public boolean isFirst()Description copied from interface:IterationMonitor
Returns true for the first iteration- Specified by:
isFirst
in interfaceIterationMonitor
-
next
public void next()Description copied from interface:IterationMonitor
Increases iteration counter- Specified by:
next
in interfaceIterationMonitor
-
iterations
public int iterations()Description copied from interface:IterationMonitor
Number of iterations performed- Specified by:
iterations
in interfaceIterationMonitor
-
converged
Description copied from interface:IterationMonitor
Checks for convergence- Specified by:
converged
in interfaceIterationMonitor
- Parameters:
r
- Residual-vectorx
- State-vector- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
converged
Description copied from interface:IterationMonitor
Checks for convergence- Specified by:
converged
in interfaceIterationMonitor
- Parameters:
r
- Residual-normx
- State-vector- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
converged
Description copied from interface:IterationMonitor
Checks for convergence- Specified by:
converged
in interfaceIterationMonitor
- Parameters:
r
- Residual-norm- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
convergedI
protected abstract boolean convergedI(double r, Vector x) throws IterativeSolverNotConvergedException -
convergedI
-
converged
Description copied from interface:IterationMonitor
Checks for convergence- Specified by:
converged
in interfaceIterationMonitor
- Parameters:
r
- Residual-vector- Returns:
- True if converged
- Throws:
IterativeSolverNotConvergedException
-
getNormType
Description copied from interface:IterationMonitor
Returns the vector-norm in use- Specified by:
getNormType
in interfaceIterationMonitor
-
setNormType
Description copied from interface:IterationMonitor
Sets the vector-norm to calculate with- Specified by:
setNormType
in interfaceIterationMonitor
-
getIterationReporter
Description copied from interface:IterationMonitor
Returns current iteration reporter- Specified by:
getIterationReporter
in interfaceIterationMonitor
-
setIterationReporter
Description copied from interface:IterationMonitor
Sets new iteration reporter- Specified by:
setIterationReporter
in interfaceIterationMonitor
-
residual
public double residual()Description copied from interface:IterationMonitor
Returns current residual- Specified by:
residual
in interfaceIterationMonitor
-