Author: psteitz
Date: Wed Dec 30 20:24:54 2009
New Revision: 894705
URL: http://svn.apache.org/viewvc?rev=894705&view=rev
Log:
Added @since tags for new methods. JIRA: MATH-287
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Product.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java?rev=894705&r1=894704&r2=894705&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
Wed Dec 30 20:24:54 2009
@@ -130,6 +130,7 @@
* @param length the number of elements to include
* @return true if the parameters are valid and designate a subarray of
positive length
* @throws IllegalArgumentException if the indices are invalid or the
array is null
+ * @since 2.1
*/
protected boolean test(
final double[] values,
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Mean.java?rev=894705&r1=894704&r2=894705&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
Wed Dec 30 20:24:54 2009
@@ -196,6 +196,7 @@
* @param length the number of elements to include
* @return the mean of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights,
final int begin, final int length) {
@@ -238,6 +239,7 @@
* @param weights the weights array
* @return the mean of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights) {
return evaluate(values, weights, 0, values.length);
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Variance.java?rev=894705&r1=894704&r2=894705&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
Wed Dec 30 20:24:54 2009
@@ -296,6 +296,7 @@
* @param length the number of elements to include
* @return the weighted variance of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights,
final int begin, final int length) {
@@ -351,6 +352,7 @@
* @param weights the weights array
* @return the weighted variance of the values
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights) {
return evaluate(values, weights, 0, values.length);
@@ -482,6 +484,7 @@
* @param length the number of elements to include
* @return the variance of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights,
final double mean, final int begin, final int
length) {
@@ -555,6 +558,7 @@
* @param mean the precomputed weighted mean value
* @return the variance of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights,
final double mean) {
return evaluate(values, weights, mean, 0, values.length);
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Product.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Product.java?rev=894705&r1=894704&r2=894705&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Product.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Product.java
Wed Dec 30 20:24:54 2009
@@ -154,6 +154,7 @@
* @param length the number of elements to include
* @return the product of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights,
final int begin, final int length) {
@@ -188,6 +189,7 @@
* @param weights the weights array
* @return the product of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights) {
return evaluate(values, weights, 0, values.length);
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Sum.java?rev=894705&r1=894704&r2=894705&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
Wed Dec 30 20:24:54 2009
@@ -154,6 +154,7 @@
* @param length the number of elements to include
* @return the sum of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights,
final int begin, final int length) {
@@ -187,6 +188,7 @@
* @param weights the weights array
* @return the sum of the values or Double.NaN if length = 0
* @throws IllegalArgumentException if the parameters are not valid
+ * @since 2.1
*/
public double evaluate(final double[] values, final double[] weights) {
return evaluate(values, weights, 0, values.length);
