mdiggory 2003/06/16 14:24:30
Modified: math/src/java/org/apache/commons/math/stat Univariate.java
UnivariateImpl.java
Log:
More correction of Javadoc errors that end up propigating into UnivarImpl and other
implementations.
Revision Changes Path
1.3 +37 -30
jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/Univariate.java
Index: Univariate.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/Univariate.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Univariate.java 16 Jun 2003 20:58:53 -0000 1.2
+++ Univariate.java 16 Jun 2003 21:24:30 -0000 1.3
@@ -72,7 +72,7 @@
*
* @author Phil Steitz
* @author <a href="mailto:[EMAIL PROTECTED]">Tim O'Brien</a>
- * @author Mark Diggory
+ * @author <a href="mailto:[EMAIL PROTECTED]">Mark Diggory</a>
* @version $Revision$ $Date$
*
*/
@@ -87,86 +87,88 @@
/**
* Returns the <a href=http://www.xycoon.com/arithmetic_mean.htm>
* arithmetic mean </a> of the available values
- * @return mean value, Double.NaN if no values have been added.
+ * @return The mean or Double.NaN if no values have been added.
*/
abstract double getMean();
/**
* Returns the <a href=http://www.xycoon.com/geometric_mean.htm>
* geometric mean </a> of the available values
- * @return The mean value, Double.NaN if no values have been added, or the
product
- * of the available values is less than or equal to 0.
+ * @return The geometricMean, Double.NaN if no values have been added,
+ * or if the productof the available values is less than or equal to 0.
*/
abstract double getGeometricMean();
/**
* Returns the product of the available values
- * @return product of all values or Double.NaN if no values have been added.
+ * @return The product or Double.NaN if no values have been added.
*/
abstract double getProduct();
/**
* Returns the variance of the available values.
- * @return The variance of a set of values, an empty set of values and 0.0 is
- * returned for a single value set, or Double.NaN if no values have been added.
+ * @return The variance, Double.NaN if no values have been added
+ * or 0.0 for a single value set.
*/
abstract double getVariance();
/**
- * Returns the variance of the available values.
- * @return standard deviation value, Double.NaN is returned for an empty set
- * of values and 0.0 is returned for a single value set.
+ * Returns the standard deviation of the available values.
+ * @return The standard deviation, Double.NaN if no values have been added
+ * or 0.0 for a single value set.
*/
abstract double getStandardDeviation();
/**
- * Returns the skewness of a given distribution. Skewness is a
+ * Returns the skewness of the available values. Skewness is a
* measure of the assymetry of a given distribution.
- * @return skewness, Double.NaN is returned for an empty set of values
- * and 0.0 is returned for a value set <=2.
+ * @return The skewness, Double.NaN if no values have been added
+ * or 0.0 for a value set <=2.
*/
abstract double getSkewness();
/**
* Returns the Kurtosis of the available values. Kurtosis is a
* measure of the "peakedness" of a distribution
- * @return kurtosis, Double.NaN is returned in no values have been added, and
0.0 is
- * returned for a value set <=3.
+ * @return The kurtosis, Double.NaN if no values have been added, or 0.0
+ * for a value set <=3.
*/
abstract double getKurtosis();
/**
* Returns the maximum of the available values
- * @return Value of property max, Double.NaN is returned in no values have been
added.
+ * @return The max or Double.NaN if no values have been added.
*/
abstract double getMax();
/**
* Returns the minimum of the available values
- * @return Value of property min, Double.NaN is returned in no values have been
added.
+ * @return The min or Double.NaN if no values have been added.
*/
abstract double getMin();
/**
* Returns the number of available values
- * @return the number of available values
+ * @return The number of available values
*/
abstract int getN();
/**
* Returns the sum of the values that have been added to Univariate.
- * @return the sum of the available values or Double.NaN if no values have been
added
+ * @return The sum or Double.NaN if no values have been added
*/
abstract double getSum();
/**
* Returns the sum of the squares of the available values.
- * Returns 0 if no values have been added.
- * @return the sum of the squares of the available values.
+ * @return The sum of the squares or Double.NaN if no
+ * values have been added.
*/
abstract double getSumsq();
- /** Resets all statistics */
+ /**
+ * Resets all statistics and storage
+ */
abstract void clear();
/**
@@ -179,15 +181,20 @@
/**
* Univariate has the ability to return only measures for the
- * last N elements added to the set of values. This function returns
- */
+ * last N elements added to the set of values.
+ * @return The current window size or -1 if its Infinite.
+ */
+
abstract int getWindowSize();
/**
- * Sets the window. windowSize controls the number of value
- * which contribute to the values returned by Univariate.
- * For example, a window value of 10 means that getMean()
- * will return the mean of the last 10 values added.
- */
+ * WindowSize controls the number of values which contribute
+ * to the values returned by Univariate. For example, if
+ * windowSize is set to 3 and the values {1,2,3,4,5}
+ * have been added <strong> in that order</strong>
+ * then the <i>available values</i> are {3,4,5} and all
+ * reported statistics will be based on these values
+ * @param windowSize sets the size of the window.
+ */
abstract void setWindowSize(int windowSize);
}
1.7 +25 -27
jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/UnivariateImpl.java
Index: UnivariateImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/UnivariateImpl.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- UnivariateImpl.java 16 Jun 2003 20:42:24 -0000 1.6
+++ UnivariateImpl.java 16 Jun 2003 21:24:30 -0000 1.7
@@ -130,17 +130,16 @@
setWindowSize(window);
}
- /** Getter for property n.
- * @return Value of property n.
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.stat.Univariate#getN()
+ */
public int getN() {
return n;
}
- /**
- * Returns the sum of all values contained herein
- * @see org.apache.commons.math.stat.Univariate#getSum()
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.stat.Univariate#getSum()
+ */
public double getSum() {
if (windowSize != Univariate.INFINITE_WINDOW) {
return super.getSum();
@@ -149,10 +148,9 @@
return sum;
}
- /**
- * Returns the sun of the squares of all values contained herein
- * @see org.apache.commons.math.stat.Univariate#getSumsq()
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.stat.Univariate#getSumsq()
+ */
public double getSumsq() {
if (windowSize != Univariate.INFINITE_WINDOW) {
return super.getSumsq();
@@ -161,9 +159,9 @@
return sumsq;
}
- /**
- * @see org.apache.commons.math.stat.Univariate#getMean()
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.stat.Univariate#getMean()
+ */
public double getMean() {
if (windowSize != Univariate.INFINITE_WINDOW) {
return super.getMean();
@@ -252,9 +250,9 @@
}
}
- /** Getter for property max.
- * @return Value of property max.
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.stat.Univariate#getMax()
+ */
public double getMax() {
if (windowSize != Univariate.INFINITE_WINDOW) {
return super.getMax();
@@ -263,9 +261,9 @@
return max;
}
- /** Getter for property min.
- * @return Value of property min.
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.stat.Univariate#getMin()
+ */
public double getMin() {
if (windowSize != Univariate.INFINITE_WINDOW) {
return super.getMin();
@@ -274,7 +272,7 @@
return min;
}
- /**
+ /* (non-Javadoc)
* @see org.apache.commons.math.stat.Univariate#getProduct()
*/
public double getProduct() {
@@ -285,7 +283,7 @@
return product;
}
- /**
+ /* (non-Javadoc)
* @see org.apache.commons.math.stat.Univariate#getGeometricMean()
*/
public double getGeometricMean() {
@@ -324,7 +322,7 @@
}
- /**
+ /* (non-Javadoc)
* @see org.apache.commons.math.stat.Univariate#addValue(double)
*/
public void addValue(double v) {
@@ -394,9 +392,9 @@
return outBuffer.toString();
}
- /**
- * Resets all stats to NaN. Reinitializes the Double Array
- */
+ /* (non-Javadoc)
+ * @see org.apache.commons.math.Univariate#clear()
+ */
public void clear() {
this.n = 0;
this.min = this.max = Double.NaN;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
