org.josef.science.math

Class AbstractRootFinder

java.lang.Object

org.josef.science.math.AbstractRootFinder

Direct Known Subclasses:

Bisection, RegulaFalsi

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public abstract class AbstractRootFinder
extends Object

Superclass for classes that will find a root of a mathematical function.

Version:

1.0 $Revision: 3753 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRootFinder() Default constructor with protected access prevents creation of an instance, except by classes in this package and sub classes.

Method Summary

Modifier and Type	Method and Description
double	getAccuracy() Gets the accuracy of the root to find.
FunctionInterval	getInterval() Gets the interval.
int	getIterations() Gets the maximum number of iterations to find a root.
void	setAccuracy(double accuracy) Sets the accuracy of the root to find.
void	setInterval(FunctionInterval interval) Sets the interval.
void	setIterations(int iterations) Sets the maximum number of iterations to find a root.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRootFinder

protected AbstractRootFinder()

Default constructor with protected access prevents creation of an instance, except by classes in this package and sub classes.

Method Detail

getIterations

public int getIterations()

Gets the maximum number of iterations to find a root.

Returns:

the iterations

setIterations

public void setIterations(int iterations)

Sets the maximum number of iterations to find a root.

Parameters:

iterations - The maximum number of iterations to find a root.

Throws:

IllegalArgumentException - When the supplied iterations <= 0.

getAccuracy

public double getAccuracy()

Gets the accuracy of the root to find.

Returns:

The accuracy of the root to find.

setAccuracy

public void setAccuracy(double accuracy)

Sets the accuracy of the root to find.

Parameters:

accuracy - The accuracy of the root to find.

Throws:

IllegalArgumentException - When the supplied accuracy <= 0.

getInterval

public FunctionInterval getInterval()

Gets the interval.

Returns:

the interval

setInterval

public void setInterval(FunctionInterval interval)

Sets the interval.

Parameters:

interval - The interval

Throws:

NullPointerException - When the supplied interval is null.