org.apache.commons.numbers.gamma

Class RegularizedBeta

java.lang.Object

org.apache.commons.numbers.gamma.RegularizedBeta

public final class RegularizedBeta
extends Object

Regularized Beta function.

This class is immutable.

Method Summary

Modifier and Type	Method and Description
static double	value(double x, double a, double b) Computes the value of the regularized beta function I(x, a, b).
static double	value(double x, double a, double b, double epsilon, int maxIterations) Computes the value of the regularized beta function I(x, a, b).

Methods inherited from class java.lang.Object

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

Method Detail

value

public static double value(double x,
                           double a,
                           double b)

Computes the value of the regularized beta function I(x, a, b).

Parameters:

x - Value.

a - Parameter a.

b - Parameter b.

Returns:

the regularized beta function I(x, a, b).

Throws:

ArithmeticException - if the algorithm fails to converge.

value

public static double value(double x,
                           double a,
                           double b,
                           double epsilon,
                           int maxIterations)

Computes the value of the regularized beta function I(x, a, b). The implementation of this method is based on:

• Regularized Beta Function.
• Regularized Beta Function.

Parameters:

x - the value.

a - Parameter a.

b - Parameter b.

epsilon - When the absolute value of the nth item in the series is less than epsilon the approximation ceases to calculate further elements in the series.

maxIterations - Maximum number of "iterations" to complete.

Returns:

the regularized beta function I(x, a, b).

Throws:

ArithmeticException - if the algorithm fails to converge.