cern.colt.matrix.tfloat.algo.solver

Class HyBRFloatIterationMonitor

java.lang.Object

cern.colt.matrix.tfloat.algo.solver.AbstractFloatIterationMonitor

cern.colt.matrix.tfloat.algo.solver.HyBRFloatIterationMonitor

All Implemented Interfaces:

FloatIterationMonitor

public class HyBRFloatIterationMonitor
extends AbstractFloatIterationMonitor

Constructor Summary

Constructors

Constructor and Description
HyBRFloatIterationMonitor() Constructor for HyBRFloatIterationMonitor.
HyBRFloatIterationMonitor(int maxIter, float dtol) Constructor for HyBRFloatIterationMonitor

Method Summary

Modifier and Type	Method and Description
boolean	converged(float r) Checks for convergence
boolean	converged(float r, FloatMatrix1D x) Checks for convergence
float	getDivergenceTolerance() Returns the relative divergence tolerance
int	getMaxIterations() Returns the maximum number of iterations
float	getRegularizationParameter() Returns the regularization parameter
cern.colt.matrix.tfloat.algo.solver.HyBRFloatIterationMonitor.HyBRStoppingCondition	getStoppingCondition() Returns the stopping condition
int	iterations() Number of iterations performed
void	setDivergenceTolerance(float dtol) Sets the relative divergence tolerance
void	setMaxIterations(int maxIter) Sets maximum number of iterations to permit
void	setRegularizationParameter(float regularizationParameter) Sets the regularization parameter
void	setStoppingCondition(cern.colt.matrix.tfloat.algo.solver.HyBRFloatIterationMonitor.HyBRStoppingCondition stoppingCondition) Sets the stopping condition

Methods inherited from class cern.colt.matrix.tfloat.algo.solver.AbstractFloatIterationMonitor

converged, converged, getIterationReporter, getNormType, isFirst, next, residual, setFirst, setIterationReporter, setNormType

Methods inherited from class java.lang.Object

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

Constructor Detail

HyBRFloatIterationMonitor

public HyBRFloatIterationMonitor()

Constructor for HyBRFloatIterationMonitor. Default is 100 iterations at most, and a divergence tolerance of 1e+5.

HyBRFloatIterationMonitor

public HyBRFloatIterationMonitor(int maxIter,
                                 float dtol)

Constructor for HyBRFloatIterationMonitor

Parameters:

maxIter - Maximum number of iterations

dtol - Relative divergence tolerance (to initial residual)

Method Detail

converged

public boolean converged(float r,
                         FloatMatrix1D x)
                  throws IterativeSolverFloatNotConvergedException

Description copied from interface: FloatIterationMonitor

Checks for convergence

Specified by:

converged in interface FloatIterationMonitor

Overrides:

converged in class AbstractFloatIterationMonitor

Parameters:

r - Residual-norm

x - State-vector

Returns:

True if converged

Throws:

IterativeSolverFloatNotConvergedException

converged

public boolean converged(float r)
                  throws IterativeSolverFloatNotConvergedException

Description copied from interface: FloatIterationMonitor

Checks for convergence

Specified by:

converged in interface FloatIterationMonitor

Overrides:

converged in class AbstractFloatIterationMonitor

Parameters:

r - Residual-norm

Returns:

True if converged

Throws:

IterativeSolverFloatNotConvergedException

getMaxIterations

public int getMaxIterations()

Description copied from interface: FloatIterationMonitor

Returns the maximum number of iterations

setMaxIterations

public void setMaxIterations(int maxIter)

Description copied from interface: FloatIterationMonitor

Sets maximum number of iterations to permit

Parameters:

maxIter - Maximum number of iterations

setDivergenceTolerance

public void setDivergenceTolerance(float dtol)

Sets the relative divergence tolerance

Parameters:

dtol - relative divergence tolerance (to initial residual)

getDivergenceTolerance

public float getDivergenceTolerance()

Returns the relative divergence tolerance

Returns:

relative divergence tolerance (to initial residual)

getRegularizationParameter

public float getRegularizationParameter()

Returns the regularization parameter

Returns:

regularization parameter

setRegularizationParameter

public void setRegularizationParameter(float regularizationParameter)

Sets the regularization parameter

Parameters:

regularizationParameter - regularization parameter

setStoppingCondition

public void setStoppingCondition(cern.colt.matrix.tfloat.algo.solver.HyBRFloatIterationMonitor.HyBRStoppingCondition stoppingCondition)

Sets the stopping condition

Parameters:

stoppingCondition - stopping condition

getStoppingCondition

public cern.colt.matrix.tfloat.algo.solver.HyBRFloatIterationMonitor.HyBRStoppingCondition getStoppingCondition()

Returns the stopping condition

Returns:

stopping condition

iterations

public int iterations()

Description copied from interface: FloatIterationMonitor

Number of iterations performed

Specified by:

iterations in interface FloatIterationMonitor

Overrides:

iterations in class AbstractFloatIterationMonitor