cern.colt.matrix.tdouble.algo.solver
Class HyBRDoubleIterationMonitor

java.lang.Object
  cern.colt.matrix.tdouble.algo.solver.AbstractDoubleIterationMonitor
      cern.colt.matrix.tdouble.algo.solver.HyBRDoubleIterationMonitor

All Implemented Interfaces:

DoubleIterationMonitor

public class HyBRDoubleIterationMonitor
extends AbstractDoubleIterationMonitor

Constructor Summary

HyBRDoubleIterationMonitor()
Constructor for HyBRDoubleIterationMonitor.

HyBRDoubleIterationMonitor(int maxIter, double dtol)
Constructor for HyBRDoubleIterationMonitor

Method Summary

boolean	converged(double r) Checks for convergence
boolean	converged(double r, DoubleMatrix1D x) Checks for convergence
double	getDivergenceTolerance() Returns the relative divergence tolerance
int	getMaxIterations() Returns the maximum number of iterations
double	getRegularizationParameter() Returns the regularization parameter
cern.colt.matrix.tdouble.algo.solver.HyBRDoubleIterationMonitor.HyBRStoppingCondition	getStoppingCondition() Returns the stopping condition
int	iterations() Number of iterations performed
void	setDivergenceTolerance(double dtol) Sets the relative divergence tolerance
void	setMaxIterations(int maxIter) Sets maximum number of iterations to permit
void	setRegularizationParameter(double regularizationParameter) Sets the regularization parameter
void	setStoppingCondition(cern.colt.matrix.tdouble.algo.solver.HyBRDoubleIterationMonitor.HyBRStoppingCondition stoppingCondition) Sets the stopping condition

Methods inherited from class cern.colt.matrix.tdouble.algo.solver.AbstractDoubleIterationMonitor

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

HyBRDoubleIterationMonitor

public HyBRDoubleIterationMonitor()

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

HyBRDoubleIterationMonitor

public HyBRDoubleIterationMonitor(int maxIter,
                                  double dtol)

Constructor for HyBRDoubleIterationMonitor

Parameters:

maxIter - Maximum number of iterations

dtol - Relative divergence tolerance (to initial residual)

Method Detail

converged

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

Description copied from interface: DoubleIterationMonitor

Checks for convergence

Specified by:

converged in interface DoubleIterationMonitor

Overrides:

converged in class AbstractDoubleIterationMonitor

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

Overrides:

converged in class AbstractDoubleIterationMonitor

Parameters:

r - Residual-norm

Returns:

True if converged

Throws:

IterativeSolverDoubleNotConvergedException

getMaxIterations

public int getMaxIterations()

Description copied from interface: DoubleIterationMonitor

Returns the maximum number of iterations

setMaxIterations

public void setMaxIterations(int maxIter)

Description copied from interface: DoubleIterationMonitor

Sets maximum number of iterations to permit

Parameters:

maxIter - Maximum number of iterations

setDivergenceTolerance

public void setDivergenceTolerance(double dtol)

Sets the relative divergence tolerance

Parameters:

dtol - relative divergence tolerance (to initial residual)

getDivergenceTolerance

public double getDivergenceTolerance()

Returns the relative divergence tolerance

Returns:

relative divergence tolerance (to initial residual)

getRegularizationParameter

public double getRegularizationParameter()

Returns the regularization parameter

Returns:

regularization parameter

setRegularizationParameter

public void setRegularizationParameter(double regularizationParameter)

Sets the regularization parameter

Parameters:

regularizationParameter - regularization parameter

setStoppingCondition

public void setStoppingCondition(cern.colt.matrix.tdouble.algo.solver.HyBRDoubleIterationMonitor.HyBRStoppingCondition stoppingCondition)

Sets the stopping condition

Parameters:

stoppingCondition - stopping condition

getStoppingCondition

public cern.colt.matrix.tdouble.algo.solver.HyBRDoubleIterationMonitor.HyBRStoppingCondition getStoppingCondition()

Returns the stopping condition

Returns:

stopping condition

iterations

public int iterations()

Description copied from interface: DoubleIterationMonitor

Number of iterations performed

Specified by:

iterations in interface DoubleIterationMonitor

Overrides:

iterations in class AbstractDoubleIterationMonitor