psteitz 2004/03/21 13:57:19
Modified: math/src/java/org/apache/commons/math/random
EmpiricalDistribution.java
math/src/java/org/apache/commons/math/stat
AbstractDescriptiveStatistics.java
math/src/java/org/apache/commons/math/stat/univariate
AbstractStorelessUnivariateStatistic.java
StorelessUnivariateStatistic.java
math/src/java/org/apache/commons/math/stat/univariate/rank
Percentile.java
math/src/java/org/apache/commons/math/util
DefaultTransformer.java
Log:
Javadoc.
Revision Changes Path
1.16 +2 -2
jakarta-commons/math/src/java/org/apache/commons/math/random/EmpiricalDistribution.java
Index: EmpiricalDistribution.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/random/EmpiricalDistribution.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- EmpiricalDistribution.java 21 Feb 2004 21:35:15 -0000 1.15
+++ EmpiricalDistribution.java 21 Mar 2004 21:57:18 -0000 1.16
@@ -70,7 +70,7 @@
/**
* Computes the empirical distribution using data read from a URL.
- * @param file url of the input file
+ * @param url url of the input file
* @throws IOException if an IO error occurs
*/
void load(URL url) throws IOException;
1.5 +2 -2
jakarta-commons/math/src/java/org/apache/commons/math/stat/AbstractDescriptiveStatistics.java
Index: AbstractDescriptiveStatistics.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/AbstractDescriptiveStatistics.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AbstractDescriptiveStatistics.java 21 Feb 2004 21:35:15 -0000 1.4
+++ AbstractDescriptiveStatistics.java 21 Mar 2004 21:57:18 -0000 1.5
@@ -145,7 +145,7 @@
}
/**
- * @see org.apache.commons.math.stat.DescriptiveStatistics#getPercentile()
+ * @see org.apache.commons.math.stat.DescriptiveStatistics#getPercentile(double)
*/
public double getPercentile(double p) {
return apply(new Percentile(p));
1.14 +12 -11
jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/AbstractStorelessUnivariateStatistic.java
Index: AbstractStorelessUnivariateStatistic.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/AbstractStorelessUnivariateStatistic.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- AbstractStorelessUnivariateStatistic.java 21 Feb 2004 21:35:15 -0000 1.13
+++ AbstractStorelessUnivariateStatistic.java 21 Mar 2004 21:57:18 -0000 1.14
@@ -17,10 +17,10 @@
/**
*
- * Abstract Implementation for StorelessUnivariateStatistics.
- * Provides the ability to extend polymophically so that
- * indiviual statistics do not need to implement these methods unless
- * there are better algorithms for handling the calculation.
+ * Abstract Implementation for the [EMAIL PROTECTED] StorelessUnivariateStatistic}
interface.
+ * <p>
+ * Provides a default <code>evaluate()</code> implementation.
+ *
* @version $Revision$ $Date$
*/
public abstract class AbstractStorelessUnivariateStatistic
@@ -28,14 +28,15 @@
implements StorelessUnivariateStatistic {
/**
- * This default implementation just calls [EMAIL PROTECTED] #increment} in a
loop and then [EMAIL PROTECTED] #getResult} to
- * compute the return value. Most implementations will override this method
with a more efficient implementation.
+ * This default implementation just calls [EMAIL PROTECTED] #increment} in a
loop over the input array and
+ * then [EMAIL PROTECTED] #getResult} to compute the return value.
+ * <p>
+ * Most implementations will override this method with a more efficient
implementation that works
+ * directly with the input array.
+ *
* @see
org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int,
int)
*/
- public double evaluate(
- final double[] values,
- final int begin,
- final int length) {
+ public double evaluate(final double[] values, final int begin, final int
length) {
if (this.test(values, begin, length)) {
this.clear();
int l = begin + length;
1.15 +5 -4
jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/StorelessUnivariateStatistic.java
Index: StorelessUnivariateStatistic.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/StorelessUnivariateStatistic.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- StorelessUnivariateStatistic.java 21 Feb 2004 21:35:15 -0000 1.14
+++ StorelessUnivariateStatistic.java 21 Mar 2004 21:57:19 -0000 1.15
@@ -17,9 +17,10 @@
/**
* Extends the definition of [EMAIL PROTECTED] UnivariateStatistic} with an [EMAIL
PROTECTED] #increment}
- * method for adding values and updating internal state incrementally. This
interface
- * is designed to be used for calculating statistics that can be computed in one
pass through
- * the data without storing the full array of sample values.
+ * method for adding values and updating internal state incrementally.
+ * <p>
+ * This interface is designed to be used for calculating statistics that can be
computed in
+ * one pass through the data without storing the full array of sample values.
*
* @version $Revision$ $Date$
*/
1.16 +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.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- Percentile.java 13 Mar 2004 20:02:28 -0000 1.15
+++ Percentile.java 21 Mar 2004 21:57:19 -0000 1.16
@@ -107,7 +107,7 @@
*
* @param values Is a double[] containing the values
* @param p Is the quantile to evaluate to.
- * @param start the first (0-based) element to include in the computation
+ * @param begin the first (0-based) element to include in the computation
* @param length the number of array elements to include
* @return the result of the evaluation or Double.NaN
* if the array is empty
1.13 +2 -2
jakarta-commons/math/src/java/org/apache/commons/math/util/DefaultTransformer.java
Index: DefaultTransformer.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/util/DefaultTransformer.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- DefaultTransformer.java 21 Feb 2004 21:35:16 -0000 1.12
+++ DefaultTransformer.java 21 Mar 2004 21:57:19 -0000 1.13
@@ -31,7 +31,7 @@
public class DefaultTransformer implements NumberTransformer, Serializable {
/**
- * @param Object o Is the object that gets transformed.
+ * @param o the object that gets transformed.
* @return a double primitive representation of the Object o.
* @throws org.apache.commons.math.MathException If it cannot successfully
* be transformed or is null.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
