|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math3.special.Erf
public class Erf
This is a utility class that provides computation methods related to the error functions.
Field Summary | |
---|---|
private static double |
X_CRIT
The number X_CRIT is used by erf(double, double) internally. |
Constructor Summary | |
---|---|
private |
Erf()
Default constructor. |
Method Summary | |
---|---|
static double |
erf(double x)
Returns the error function. |
static double |
erf(double x1,
double x2)
Returns the difference between erf(x1) and erf(x2). |
static double |
erfc(double x)
Returns the complementary error function. |
static double |
erfcInv(double x)
Returns the inverse erfc. |
static double |
erfInv(double x)
Returns the inverse erf. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final double X_CRIT
X_CRIT
is used by erf(double, double)
internally.
This number solves erf(x)=0.5
within 1ulp.
More precisely, the current implementations of
erf(double)
and erfc(double)
satisfy:erf(X_CRIT) < 0.5
,erf(Math.nextUp(X_CRIT) > 0.5
,erfc(X_CRIT) = 0.5
, anderfc(Math.nextUp(X_CRIT) < 0.5
Constructor Detail |
---|
private Erf()
Method Detail |
---|
public static double erf(double x)
erf(x) = 2/√π 0∫x e-t2dt
This implementation computes erf(x) using the
regularized gamma function
,
following Erf, equation (3)
The value returned is always between -1 and 1 (inclusive).
If abs(x) > 40
, then erf(x)
is indistinguishable from
either 1 or -1 as a double, so the appropriate extreme value is returned.
x
- the value.
MaxCountExceededException
- if the algorithm fails to converge.Gamma.regularizedGammaP(double, double, double, int)
public static double erfc(double x)
erfc(x) = 2/√π x∫∞ e-t2dt
= 1 - erf(x)
This implementation computes erfc(x) using the
regularized gamma function
,
following Erf, equation (3).
The value returned is always between 0 and 2 (inclusive).
If abs(x) > 40
, then erf(x)
is indistinguishable from
either 0 or 2 as a double, so the appropriate extreme value is returned.
x
- the value
MaxCountExceededException
- if the algorithm fails to converge.Gamma.regularizedGammaQ(double, double, double, int)
public static double erf(double x1, double x2)
x1
- the first valuex2
- the second value
public static double erfInv(double x)
This implementation is described in the paper: Approximating the erfinv function by Mike Giles, Oxford-Man Institute of Quantitative Finance, which was published in GPU Computing Gems, volume 2, 2010. The source code is available here.
x
- the value
public static double erfcInv(double x)
x
- the value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |