* Provides a generic means to evaluate continued fractions. Subclasses simply * provided the a and b coefficients to evaluate the continued fraction. - *
* - *
- * Reference:
- *
- * Continued Fraction
- *
* Evaluates the continued fraction at the value x. - *
* - ** The implementation of this method is based on: *
p
*/
public double inverseCummulativeProbability(final double p) {
- if (p < 0.0 || p > 1.0){
+ if (p < 0.0 || p > 1.0) {
throw new IllegalArgumentException(
"p must be between 0.0 and 1.0, inclusive.");
}
diff --git a/src/java/org/apache/commons/math/distribution/ChiSquaredDistribution.java b/src/java/org/apache/commons/math/distribution/ChiSquaredDistribution.java
index 0ca8ec4dc..e6bcd9581 100644
--- a/src/java/org/apache/commons/math/distribution/ChiSquaredDistribution.java
+++ b/src/java/org/apache/commons/math/distribution/ChiSquaredDistribution.java
@@ -54,21 +54,16 @@
package org.apache.commons.math.stat.distribution;
/**
- * - * The Chi-Squared Distribution - *
+ * The Chi-Squared Distribution. * - ** Instances of ChiSquaredDistribution objects should be created using - * {@link DistributionFactory#createChiSquareDistribution(double)} - *
+ * {@link DistributionFactory#createChiSquareDistribution(double)}. * - ** References: *
* This factory provids the means to create common statistical distributions. * The following distributions are supported: *
* Common usage:
* DistributionFactory factory = DistributionFactory.newInstance(); * * // create a Chi-Square distribution with 5 degrees of freedom. * ChiSquaredDistribution chi = factory.createChiSquareDistribution(5.0); *- * * * @author Brent Worden */ diff --git a/src/java/org/apache/commons/math/distribution/ExponentialDistribution.java b/src/java/org/apache/commons/math/distribution/ExponentialDistribution.java index 6b0f60277..8a1e8d56b 100644 --- a/src/java/org/apache/commons/math/distribution/ExponentialDistribution.java +++ b/src/java/org/apache/commons/math/distribution/ExponentialDistribution.java @@ -54,21 +54,15 @@ package org.apache.commons.math.stat.distribution; /** - *
- * The Exponential Distribution - *
+ * The Exponential Distribution. * - ** Instances of ExponentialDistribution objects should be created using - * {@link DistributionFactory#createExponentialDistribution(double)} - *
+ * {@link DistributionFactory#createExponentialDistribution(double)}. * - ** References: *
* For this disbution, X, this method returns P(X < x). - *
* - ** The implementation of this method is based on: *
p
*/
- public double inverseCummulativeProbability(double p){
+ public double inverseCummulativeProbability(double p) {
double ret;
- if(p < 0.0 || p > 1.0){
+ if (p < 0.0 || p > 1.0) {
ret = Double.NaN;
- } else if(p == 1.0){
+ } else if (p == 1.0) {
ret = Double.POSITIVE_INFINITY;
} else {
ret = -getMean() * Math.log(1.0 - p);
diff --git a/src/java/org/apache/commons/math/distribution/FDistribution.java b/src/java/org/apache/commons/math/distribution/FDistribution.java
index 76b09b389..aadc52a55 100644
--- a/src/java/org/apache/commons/math/distribution/FDistribution.java
+++ b/src/java/org/apache/commons/math/distribution/FDistribution.java
@@ -54,20 +54,16 @@
package org.apache.commons.math.stat.distribution;
/**
- * * F-Distribution. - *
* - ** Instances of FDistribution objects should be created using - * {@link DistributionFactory#createFDistribution(double,double)} - *
+ * {@link DistributionFactory#createFDistribution(double,double)}. * - *
- * Reference:
- *
- * F-Distribution
- *
* For this disbution, X, this method returns P(X < x). - *
* - ** The implementation of this method is based on: *
p
*/
- protected double getDomainLowerBound(double p){
+ protected double getDomainLowerBound(double p) {
return 0.0;
}
@@ -136,7 +133,7 @@ public class FDistributionImpl
* @return domain value upper bound, i.e.
* P(X < upper bound) > p
*/
- protected double getDomainUpperBound(double p){
+ protected double getDomainUpperBound(double p) {
return Double.MAX_VALUE;
}
@@ -148,16 +145,17 @@ public class FDistributionImpl
* @param p the desired probability for the critical value
* @return initial domain value
*/
- protected double getInitialDomain(double p){
- return getDenominatorDegreesOfFreedom() / (getDenominatorDegreesOfFreedom() - 2.0);
+ protected double getInitialDomain(double p) {
+ return getDenominatorDegreesOfFreedom() /
+ (getDenominatorDegreesOfFreedom() - 2.0);
}
/**
* Modify the numerator degrees of freedom.
* @param degreesOfFreedom the new numerator degrees of freedom.
*/
- public void setNumeratorDegreesOfFreedom(double degreesOfFreedom){
- if(degreesOfFreedom <= 0.0){
+ public void setNumeratorDegreesOfFreedom(double degreesOfFreedom) {
+ if (degreesOfFreedom <= 0.0) {
throw new IllegalArgumentException(
"degrees of freedom must be positive.");
}
@@ -168,7 +166,7 @@ public class FDistributionImpl
* Access the numerator degrees of freedom.
* @return the numerator degrees of freedom.
*/
- public double getNumeratorDegreesOfFreedom(){
+ public double getNumeratorDegreesOfFreedom() {
return numeratorDegreesOfFreedom;
}
@@ -176,8 +174,8 @@ public class FDistributionImpl
* Modify the denominator degrees of freedom.
* @param degreesOfFreedom the new denominator degrees of freedom.
*/
- public void setDenominatorDegreesOfFreedom(double degreesOfFreedom){
- if(degreesOfFreedom <= 0.0){
+ public void setDenominatorDegreesOfFreedom(double degreesOfFreedom) {
+ if (degreesOfFreedom <= 0.0) {
throw new IllegalArgumentException(
"degrees of freedom must be positive.");
}
@@ -188,7 +186,7 @@ public class FDistributionImpl
* Access the denominator degrees of freedom.
* @return the denominator degrees of freedom.
*/
- public double getDenominatorDegreesOfFreedom(){
+ public double getDenominatorDegreesOfFreedom() {
return denominatorDegreesOfFreedom;
}
}
diff --git a/src/java/org/apache/commons/math/distribution/GammaDistribution.java b/src/java/org/apache/commons/math/distribution/GammaDistribution.java
index 1c6c389f2..c86713591 100644
--- a/src/java/org/apache/commons/math/distribution/GammaDistribution.java
+++ b/src/java/org/apache/commons/math/distribution/GammaDistribution.java
@@ -54,21 +54,16 @@
package org.apache.commons.math.stat.distribution;
/**
- * - * The Gamma Distribution - *
+ * The Gamma Distribution. * - ** Instances of GammaDistribution objects should be created using - * {@link DistributionFactory#createGammaDistribution(double,double)} - *
+ * {@link DistributionFactory#createGammaDistribution(double,double)}. * - ** References: *
* For this disbution, X, this method returns P(X < x). - *
* - ** The implementation of this method is based on: *
* Student's t-Distribution. - *
* - ** Instances of TDistribution objects should be created using * {@link DistributionFactory#createTDistribution(double)} - *
* - *
- * Reference:
- *
- * Student's t-Distribution
- *
p
*/
- protected double getDomainLowerBound(double p){
+ protected double getDomainLowerBound(double p) {
return -Double.MAX_VALUE;
}
@@ -143,7 +143,7 @@ public class TDistributionImpl
* @return domain value upper bound, i.e.
* P(X < upper bound) > p
*/
- protected double getDomainUpperBound(double p){
+ protected double getDomainUpperBound(double p) {
return Double.MAX_VALUE;
}
@@ -155,7 +155,7 @@ public class TDistributionImpl
* @param p the desired probability for the critical value
* @return initial domain value
*/
- protected double getInitialDomain(double p){
+ protected double getInitialDomain(double p) {
return 0.0;
}
}
diff --git a/src/java/org/apache/commons/math/special/Beta.java b/src/java/org/apache/commons/math/special/Beta.java
index 1af354b96..8ec4ad72d 100644
--- a/src/java/org/apache/commons/math/special/Beta.java
+++ b/src/java/org/apache/commons/math/special/Beta.java
@@ -73,9 +73,7 @@ public class Beta {
}
/**
- * * Returns the regularized beta function I(x, a, b). - *
* * @param x ??? * @param a ??? @@ -87,39 +85,40 @@ public class Beta { } /** - ** Returns the regularized beta function I(x, a, b). - *
* * @param x ??? * @param a ??? * @param b ??? + * @param 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. * @return the regularized beta function I(x, a, b) */ - public static double regularizedBeta(double x, double a, double b, double epsilon) { + public static double regularizedBeta(double x, double a, double b, + double epsilon) { + return regularizedBeta(x, a, b, epsilon, Integer.MAX_VALUE); } /** - ** Returns the regularized beta function I(x, a, b). - *
* * @param x ??? * @param a ??? * @param b ??? + * @param maxIterations Maximum number of "iterations" to complete. * @return the regularized beta function I(x, a, b) */ - public static double regularizedBeta(double x, double a, double b, int maxIterations) { + public static double regularizedBeta(double x, double a, double b, + int maxIterations) { + return regularizedBeta(x, a, b, DEFAULT_EPSILON, maxIterations); } /** - ** Returns the regularized beta function I(x, a, b). - *
* - ** The implementation of this method is based on: *
* Returns the natural logarithm of the beta function B(a, b). - *
* * @param a ??? * @param b ??? @@ -201,23 +206,25 @@ public class Beta { } /** - ** Returns the natural logarithm of the beta function B(a, b). - *
* - ** The implementation of this method is based on: *
* Returns the regularized gamma function P(a, x). - *
* * @param a ??? * @param x ??? @@ -107,11 +105,8 @@ public class Gamma { } /** - ** Returns the regularized gamma function P(a, x). - *
* - ** The implementation of this method is based on: *
* Returns the natural logarithm of the gamma function Γ(x). - *
* - ** The implementation of this method is based on: *
- * * * @param x ??? * @return log(Γ(x))