Author: psteitz
Date: Wed Sep 4 17:24:02 2013
New Revision: 1520076
URL: http://svn.apache.org/r1520076
Log:
Clarified javadoc for setXxxImpl methods. JIRA: MATH-1023.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java?rev=1520076&r1=1520075&r2=1520076&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
Wed Sep 4 17:24:02 2013
@@ -418,9 +418,10 @@ public class SummaryStatistics implement
* Sets the implementation for the Sum.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param sumImpl the StorelessUnivariateStatistic instance to use for
* computing the Sum
@@ -447,9 +448,10 @@ public class SummaryStatistics implement
* Sets the implementation for the sum of squares.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param sumsqImpl the StorelessUnivariateStatistic instance to use for
* computing the sum of squares
@@ -476,9 +478,10 @@ public class SummaryStatistics implement
* Sets the implementation for the minimum.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param minImpl the StorelessUnivariateStatistic instance to use for
* computing the minimum
@@ -505,9 +508,10 @@ public class SummaryStatistics implement
* Sets the implementation for the maximum.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param maxImpl the StorelessUnivariateStatistic instance to use for
* computing the maximum
@@ -534,9 +538,10 @@ public class SummaryStatistics implement
* Sets the implementation for the sum of logs.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param sumLogImpl the StorelessUnivariateStatistic instance to use for
* computing the log sum
@@ -564,9 +569,10 @@ public class SummaryStatistics implement
* Sets the implementation for the geometric mean.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param geoMeanImpl the StorelessUnivariateStatistic instance to use for
* computing the geometric mean
@@ -593,9 +599,10 @@ public class SummaryStatistics implement
* Sets the implementation for the mean.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param meanImpl the StorelessUnivariateStatistic instance to use for
* computing the mean
@@ -622,9 +629,10 @@ public class SummaryStatistics implement
* Sets the implementation for the variance.
* </p>
* <p>
- * This method must be activated before any data has been added - i.e.,
- * before {@link #addValue(double) addValue} has been used to add data;
- * otherwise an IllegalStateException will be thrown.
+ * This method cannot be activated after data has been added - i.e.,
+ * after {@link #addValue(double) addValue} has been used to add data.
+ * If it is activated after data has been added, an IllegalStateException
+ * will be thrown.
* </p>
* @param varianceImpl the StorelessUnivariateStatistic instance to use for
* computing the variance
