org.josef.science.math

Interface RootFinderStrategy

All Known Implementing Classes:

Bisection, RegulaFalsi

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @FunctionalInterface
public interface RootFinderStrategy

Strategy interface for concrete strategy classes that can find the root of a function.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

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.

Method Detail

findRoot

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.