jsat.math.rootfinding

Class Zeroin

java.lang.Object

jsat.math.rootfinding.Zeroin

All Implemented Interfaces:

Serializable, RootFinder

public class Zeroin
extends Object
implements RootFinder

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Zeroin()

Method Summary

Modifier and Type	Method and Description
int	guessesNeeded() Different root finding methods require different numbers of initial guesses.
static double	root(double eps, double a, double b, Function f, double... args)
static double	root(double eps, double a, double b, int pos, Function f, double... args)
static double	root(double a, double b, Function f, double... args)
double	root(double eps, int maxIterations, double[] initialGuesses, Function f, int pos, double... args) Attempts to numerical compute the root of a given function, such that f(args) = 0.
double	root(double eps, int maxIterations, double[] initialGuesses, Function f, int pos, Vec args) Attempts to numerical compute the root of a given function, such that f(args) = 0.
static double	root(double eps, int maxIterations, double a, double b, int pos, Function f, double... args) Performs root finding on the function f.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Zeroin

public Zeroin()

Method Detail

root

public static double root(double a,
                          double b,
                          Function f,
                          double... args)

root

public static double root(double eps,
                          double a,
                          double b,
                          Function f,
                          double... args)

root

public static double root(double eps,
                          double a,
                          double b,
                          int pos,
                          Function f,
                          double... args)

root

public static double root(double eps,
                          int maxIterations,
                          double a,
                          double b,
                          int pos,
                          Function f,
                          double... args)

Performs root finding on the function f.

Parameters:

eps - the desired accuracy of the result

maxIterations - the maximum number of iterations to perform

a - the left bound on the root

b - the right bound on the root

pos - the position of the argument array that should be used as the variable to alter

f - the function to find the root of

args - the array of variable values for the function, one of which will be altered in the search

Returns:

the value of variable pos that produces a zero value output

root

public double root(double eps,
                   int maxIterations,
                   double[] initialGuesses,
                   Function f,
                   int pos,
                   double... args)

Description copied from interface: RootFinder

Attempts to numerical compute the root of a given function, such that f(args) = 0. Only one variable may be altered at a time

Specified by:

root in interface RootFinder

Parameters:

eps - the accuracy desired for the solution

maxIterations - the maximum number of steps allowed before forcing a return of the current solution.

initialGuesses - an array containing the initial guess values

f - the function to find the root of

pos - the index of the argument that will be allowed to alter in order to find the root. Starts from 0

args - the values to be passed to the function as arguments

Returns:

the value of the variable at the index pos that makes the function return 0

root

public double root(double eps,
                   int maxIterations,
                   double[] initialGuesses,
                   Function f,
                   int pos,
                   Vec args)

Description copied from interface: RootFinder

Attempts to numerical compute the root of a given function, such that f(args) = 0. Only one variable may be altered at a time

Specified by:

root in interface RootFinder

Parameters:

eps - the accuracy desired for the solution

maxIterations - the maximum number of steps allowed before forcing a return of the current solution.

initialGuesses - an array containing the initial guess values

f - the function to find the root of

pos - the index of the argument that will be allowed to alter in order to find the root. Starts from 0

args - the values to be passed to the function as arguments

Returns:

the value of the variable at the index pos that makes the function return 0

guessesNeeded

public int guessesNeeded()

Description copied from interface: RootFinder

Different root finding methods require different numbers of initial guesses. Some root finding methods require 2 guesses, each with values of opposite sign so that they bracket the root. Others just need any 2 initial guesses sufficiently close to the root. This method simply returns the number of guesses that are needed.

Specified by:

guessesNeeded in interface RootFinder

Returns:

the number of initial guesses this root finding method needs