You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ps...@apache.org on 2004/03/04 05:25:09 UTC
cvs commit: jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary Product.java Sum.java SumOfLogs.java SumOfSquares.java
psteitz 2004/03/03 20:25:09
Modified: math/src/java/org/apache/commons/math/stat StatUtils.java
math/src/java/org/apache/commons/math/stat/univariate
AbstractUnivariateStatistic.java
UnivariateStatistic.java
math/src/java/org/apache/commons/math/stat/univariate/moment
GeometricMean.java Kurtosis.java Mean.java
Skewness.java StandardDeviation.java Variance.java
math/src/java/org/apache/commons/math/stat/univariate/rank
Percentile.java
math/src/java/org/apache/commons/math/stat/univariate/summary
Product.java Sum.java SumOfLogs.java
SumOfSquares.java
Log:
Javadoc.
Revision Changes Path
1.25 +10 -10 jakarta-commons/math/src/java/org/apache/commons/math/stat/StatUtils.java
Index: StatUtils.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/StatUtils.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- StatUtils.java 21 Feb 2004 21:35:15 -0000 1.24
+++ StatUtils.java 4 Mar 2004 04:25:09 -0000 1.25
@@ -80,7 +80,7 @@
* The sum of the values that have been added to Univariate.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the sum of the values or Double.NaN if the array is empty
*/
public static double sum(
@@ -103,7 +103,7 @@
* Returns the sum of the squares of the available values.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the sum of the squared values or Double.NaN if the array is empty
*/
public static double sumSq(
@@ -126,7 +126,7 @@
* Returns the product for this collection of values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the product values or Double.NaN if the array is empty
*/
public static double product(
@@ -149,7 +149,7 @@
* Returns the sum of the natural logs for this collection of values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the sumLog value or Double.NaN if the array is empty
*/
public static double sumLog(
@@ -174,7 +174,7 @@
* arithmetic mean </a> of the available values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the mean of the values or Double.NaN if the array is empty
*/
public static double mean(
@@ -212,7 +212,7 @@
*
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the result, Double.NaN if no values for an empty array
* or 0.0 for a single value set.
*/
@@ -236,7 +236,7 @@
* Returns the maximum of the available values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the maximum of the values or Double.NaN if the array is empty
*/
public static double max(
@@ -259,7 +259,7 @@
* Returns the minimum of the available values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the minimum of the values or Double.NaN if the array is empty
*/
public static double min(
@@ -303,7 +303,7 @@
*
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @param p the requested percentile (scaled from 0 - 100)
* @return An estimate for the pth percentile of the data values
*/
1.13 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/AbstractUnivariateStatistic.java
Index: AbstractUnivariateStatistic.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/AbstractUnivariateStatistic.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- AbstractUnivariateStatistic.java 21 Feb 2004 21:35:15 -0000 1.12
+++ AbstractUnivariateStatistic.java 4 Mar 2004 04:25:09 -0000 1.13
@@ -47,7 +47,7 @@
* should continue, or return <code>Double.NaN</code> </p>
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return true if the array has postive length
* @throws IllegalArgumentException if the indices are invalid or the array is null
*/
1.13 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/UnivariateStatistic.java
Index: UnivariateStatistic.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/UnivariateStatistic.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- UnivariateStatistic.java 21 Feb 2004 21:35:15 -0000 1.12
+++ UnivariateStatistic.java 4 Mar 2004 04:25:09 -0000 1.13
@@ -37,7 +37,7 @@
* of the evaluation.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the result of the evaluation or Double.NaN
* if the array is empty
*/
1.17 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/GeometricMean.java
Index: GeometricMean.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/GeometricMean.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- GeometricMean.java 21 Feb 2004 21:35:15 -0000 1.16
+++ GeometricMean.java 4 Mar 2004 04:25:09 -0000 1.17
@@ -70,7 +70,7 @@
* Returns the geometric mean for this collection of values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the geometric mean or Double.NaN if the array is empty or
* any of the values are <= 0.
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
1.17 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Kurtosis.java
Index: Kurtosis.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Kurtosis.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Kurtosis.java 21 Feb 2004 21:35:15 -0000 1.16
+++ Kurtosis.java 4 Mar 2004 04:25:09 -0000 1.17
@@ -131,7 +131,7 @@
* </p>
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the kurtosis of the values or Double.NaN if the array is empty
*/
public double evaluate(
1.16 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Mean.java
Index: Mean.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Mean.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- Mean.java 21 Feb 2004 21:35:15 -0000 1.15
+++ Mean.java 4 Mar 2004 04:25:09 -0000 1.16
@@ -97,7 +97,7 @@
* arithmetic mean </a> of a double[] of the available values.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the mean of the values or Double.NaN if the array is empty
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
*/
1.17 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Skewness.java
Index: Skewness.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Skewness.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Skewness.java 21 Feb 2004 21:35:15 -0000 1.16
+++ Skewness.java 4 Mar 2004 04:25:09 -0000 1.17
@@ -122,7 +122,7 @@
* </p>
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the skewness of the values or Double.NaN if the array is empty
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
*/
1.15 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/StandardDeviation.java
Index: StandardDeviation.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/StandardDeviation.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- StandardDeviation.java 21 Feb 2004 21:35:15 -0000 1.14
+++ StandardDeviation.java 4 Mar 2004 04:25:09 -0000 1.15
@@ -82,7 +82,7 @@
* Returns the Standard Deviation on an array of values.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the result, Double.NaN if no values for an empty array
* or 0.0 for a single value set.
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
1.18 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Variance.java
Index: Variance.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Variance.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Variance.java 21 Feb 2004 21:35:15 -0000 1.17
+++ Variance.java 4 Mar 2004 04:25:09 -0000 1.18
@@ -131,7 +131,7 @@
* </p>
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the result, Double.NaN if no values for an empty array
* or 0.0 for a single value set.
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
1.14 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Percentile.java
Index: Percentile.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Percentile.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- Percentile.java 21 Feb 2004 21:35:16 -0000 1.13
+++ Percentile.java 4 Mar 2004 04:25:09 -0000 1.14
@@ -76,7 +76,7 @@
* statistic.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @param p Is the percentile to evaluate to.*
* @return the result of the evaluation or Double.NaN
* if the array is empty
1.15 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/Product.java
Index: Product.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/Product.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Product.java 21 Feb 2004 21:35:16 -0000 1.14
+++ Product.java 4 Mar 2004 04:25:09 -0000 1.15
@@ -78,7 +78,7 @@
* Returns the product for this collection of values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the product values or Double.NaN if the array is empty
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
*/
1.17 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/Sum.java
Index: Sum.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/Sum.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Sum.java 21 Feb 2004 21:35:16 -0000 1.16
+++ Sum.java 4 Mar 2004 04:25:09 -0000 1.17
@@ -72,7 +72,7 @@
* The sum of the values that have been added to Univariate.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the sum of the values or Double.NaN if the array is empty
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
*/
1.15 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/SumOfLogs.java
Index: SumOfLogs.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/SumOfLogs.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- SumOfLogs.java 21 Feb 2004 21:35:16 -0000 1.14
+++ SumOfLogs.java 4 Mar 2004 04:25:09 -0000 1.15
@@ -83,7 +83,7 @@
* Returns the sum of the natural logs for this collection of values
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the sumLog value or Double.NaN if the array is empty
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
*/
1.15 +2 -2 jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/SumOfSquares.java
Index: SumOfSquares.java
===================================================================
RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/summary/SumOfSquares.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- SumOfSquares.java 21 Feb 2004 21:35:16 -0000 1.14
+++ SumOfSquares.java 4 Mar 2004 04:25:09 -0000 1.15
@@ -78,7 +78,7 @@
* Returns the sum of the squares of the available values.
* @param values Is a double[] containing the values
* @param begin processing at this point in the array
- * @param length processing at this point in the array
+ * @param length the number of elements to include
* @return the sum of the squared values or Double.NaN if the array is empty
* @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org