QuickRootFinding Type

Provides static methods for quick and dirty root finding without instantiating a class.

Constructors

Constructor Description

QuickRootFinding()

Full Usage: QuickRootFinding()

Static members

Static member Description

QuickRootFinding.BracketRootByExtensionOnly(func, ysearch, x0, x1)

Full Usage: QuickRootFinding.BracketRootByExtensionOnly(func, ysearch, x0, x1)

Parameters:
    func : Func<float, float> - The function used to evaluate the function values.
    ysearch : float - The value to find.
    x0 : byref<float> - Starting parameter of x0, at the end the lower value of the bracket interval.
    x1 : byref<float> - Starting parameter of x1, at the end the upper value of the bracket interval.

Returns: bool True if a bracket interval was found. If such an interval could not be found, the return value is false.

Find the bracket of a root, i.e. values for x0 and x1, so that ysearch is inbetween f(x0) and f(x1). This is done be extension of the interval [x0,x1] either to the left or the right side or both.

func : Func<float, float>

The function used to evaluate the function values.

ysearch : float

The value to find.

x0 : byref<float>

Starting parameter of x0, at the end the lower value of the bracket interval.

x1 : byref<float>

Starting parameter of x1, at the end the upper value of the bracket interval.

Returns: bool

True if a bracket interval was found. If such an interval could not be found, the return value is false.

QuickRootFinding.ByBrentsAlgorithm(f, x0, x1)

Full Usage: QuickRootFinding.ByBrentsAlgorithm(f, x0, x1)

Parameters:
    f : Func<float, float>
    x0 : float
    x1 : float

Returns: float

f : Func<float, float>
x0 : float
x1 : float
Returns: float

QuickRootFinding.ByBrentsAlgorithm(f, x0, x1, epsabs, epsrel)

Full Usage: QuickRootFinding.ByBrentsAlgorithm(f, x0, x1, epsabs, epsrel)

Parameters:
    f : Func<float, float>
    x0 : float
    x1 : float
    epsabs : float
    epsrel : float

Returns: float

f : Func<float, float>
x0 : float
x1 : float
epsabs : float
epsrel : float
Returns: float

QuickRootFinding.ByBrentsAlgorithm(f, x0, x1, epsabs, epsrel, root)

Full Usage: QuickRootFinding.ByBrentsAlgorithm(f, x0, x1, epsabs, epsrel, root)

Parameters:
    f : Func<float, float>
    x0 : float
    x1 : float
    epsabs : float
    epsrel : float
    root : byref<float>

Returns: GSL_ERROR

f : Func<float, float>
x0 : float
x1 : float
epsabs : float
epsrel : float
root : byref<float>
Returns: GSL_ERROR