ca.nengo.math

Interface RootFinder

All Known Implementing Classes:

NewtonRootFinder

public interface RootFinder

Finds a root of a function.

Method Summary

Methods

Modifier and Type	Method and Description
float	findRoot(Function function, float startLow, float startHigh, float tolerance)

Method Detail

findRoot

float findRoot(Function function,
             float startLow,
             float startHigh,
             float tolerance)

Parameters:

function - Function f(x) to find root of

startLow - Low-valued x from which to start search

startHigh - High-valued x from which to start. You typically give startLow and startHigh so that you expect the signs of the functions at these values to be different.

tolerance - Max acceptable |f(x)| for which to return x

Returns:

x for which |f(x)| <= tolerance