com.opengamma.strata.math.impl.rootfinding

Interface SingleRootFinder<S,T>

Type Parameters:

S - The input type of the function

T - The output type of the function

All Known Implementing Classes:

BaseNewtonVectorRootFinder, BisectionSingleRootFinder, BrentSingleRootFinder, BroydenVectorRootFinder, NewtonDefaultVectorRootFinder, NewtonRaphsonSingleRootFinder, RealSingleRootFinder, RidderSingleRootFinder, ShermanMorrisonVectorRootFinder, VectorRootFinder

public interface SingleRootFinder<S,T>

Interface for classes that attempt to find a root for a one-dimensional function (see Function) $f(x)$ bounded by user-supplied values, $x_1$ and $x_2$. If there is not a single root between these bounds, an exception is thrown.

Method Summary

Modifier and Type	Method and Description
S	getRoot(Function<S,T> function, S... roots) Finds the root.

Method Detail

getRoot

S getRoot(Function<S,T> function,
          S... roots)

Finds the root.

Parameters:

function - the function, not null

roots - the roots, not null

Returns:

a root lying between x1 and x2