net.sf.doodleproject.numerics4j
Class IterativeMethod

java.lang.Object
  net.sf.doodleproject.numerics4j.IterativeMethod

Direct Known Subclasses:

AdaptiveIntegrator, BisectionRootFinder, BrentRootFinder, ContinuedFraction, FalsePositionRootFinder, NewtonRootFinder, PowerSeries, RombergIntegrator, SecantRootFinder, Series, SimpsonsIntegrator, TrapezoidalIntegrator

public abstract class IterativeMethod
extends java.lang.Object

A method to solve generic problems by finding successive (and hopefully better) approximations to the solution.

Version:

$Revision: 1.2 $ $Date: 2007/10/25 04:44:23 $

Nested Class Summary

static interface

IterativeMethod.IterativeState The current state for an iterative method.

Constructor Summary

protected	IterativeMethod() Default constructor.
protected	IterativeMethod(int iterations, double error) Create an iterative method with the given number of maximum iterations and maximum relative error.

Method Summary

int	getMaximumIterations() Access the maximum number of iterations.
double	getMaximumRelativeError() Access the maximum relative error.
void	iterate(IterativeMethod.IterativeState state) Perform the iterative evaluation.
void	setMaximumIterations(int iterations) Modify the maximum number of iterations.
void	setMaximumRelativeError(double error) Modify the maximum relative error.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterativeMethod

protected IterativeMethod()

Default constructor. Maximum iterations is set to 100 and maximum relative error is set to 1×10^-10.

IterativeMethod

protected IterativeMethod(int iterations,
                          double error)

Create an iterative method with the given number of maximum iterations and maximum relative error.

Parameters:

iterations - maximum number of iterations.

error - maximum relative error.

Method Detail

getMaximumIterations

public int getMaximumIterations()

Access the maximum number of iterations.

Returns:

the maximum number of iterations.

getMaximumRelativeError

public double getMaximumRelativeError()

Access the maximum relative error.

Returns:

the maximum relative error.

iterate

public void iterate(IterativeMethod.IterativeState state)
             throws NumericException

Perform the iterative evaluation. state is used to manage state between iterations.

Parameters:

state - the state for this iterative method evaluation.

Throws:

NumericException - if a solution to the iterative method can not be computed.

setMaximumIterations

public void setMaximumIterations(int iterations)

Modify the maximum number of iterations.

Parameters:

iterations - the new maximum number of iterations value.

setMaximumRelativeError

public void setMaximumRelativeError(double error)

Modify the maximum relative error.

Parameters:

error - the new maximum relative error.