org.josef.science.math

Class RootFinderContext

java.lang.Object

org.josef.science.math.RootFinderContext

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @ThreadSafety(level=NOT_THREAD_SAFE)
public class RootFinderContext
extends Object

Context to find a root of a function using different strategies.

Version:

1.0 $Revision: 3753 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
RootFinderContext(RootFinderStrategy strategy) Constructs this RootFinder from the supplied strategy.

Method Summary

Modifier and Type	Method and Description
double	findRoot(SingleParameterFunction function, double left, double right) Finds a root of the supplied function, within the supplied interval [left, right], using a RootFinderStrategy.
void	setRootFinderStrategy(RootFinderStrategy strategy) Sets the strategy to find a root of a function.

Methods inherited from class java.lang.Object

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

Constructor Detail

RootFinderContext

public RootFinderContext(RootFinderStrategy strategy)

Constructs this RootFinder from the supplied strategy.

Parameters:

strategy - The strategy to find a root of a function.

Throws:

NullPointerException - When the supplied strategy is null.

Method Detail

setRootFinderStrategy

public void setRootFinderStrategy(RootFinderStrategy strategy)

Sets the strategy to find a root of a function.

Parameters:

strategy - The strategy to find a root of a function.

Throws:

NullPointerException - When the supplied strategy is null.

findRoot

public double findRoot(SingleParameterFunction function,
                       double left,
                       double right)

Finds a root of the supplied function, within the supplied interval [left, right], using a RootFinderStrategy.

Parameters:

function - The function for which a root should be found.

left - x value of the left side of the interval.
The y value, that is the value of function(left) should have a sign that is opposite to that of function(right).

right - x value of the right side of the interval.
The y value, that is the value of function(right) should have a sign that is opposite to that of function(left).

Returns:

A root of the supplied function within the supplied interval[ left, right].

Throws:

IllegalArgumentException - When left equals right or when both function(left) and function(right) are of equal sign or when either function(left) or function(right) is "Not a Number".

NullPointerException - when the supplied function is null.