org.spaceroots.mantissa.roots

Interface RootsFinder

All Known Implementing Classes:

BrentSolver

public interface RootsFinder

This interface specifies root-finding methods for scalar functions.

Method Summary

Modifier and Type	Method and Description
boolean	findRoot(ComputableFunction function, ConvergenceChecker checker, int maxIter, double x0, double f0, double x1, double f1) Solve a function in a given interval known to contain a root.
double	getRoot() Get the abscissa of the root.

Method Detail

findRoot

boolean findRoot(ComputableFunction function,
                 ConvergenceChecker checker,
                 int maxIter,
                 double x0,
                 double f0,
                 double x1,
                 double f1)
          throws FunctionException

Solve a function in a given interval known to contain a root.

Parameters:

function - function for which a root should be found

checker - checker for the convergence of the function

maxIter - maximal number of iteration allowed

x0 - abscissa of the lower bound of the interval

f0 - value of the function the lower bound of the interval

x1 - abscissa of the higher bound of the interval

f1 - value of the function the higher bound of the interval

Returns:

true if a root has been found in the given interval

Throws:

FunctionException

getRoot

double getRoot()

Get the abscissa of the root.

Returns:

abscissa of the root