commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From l..@apache.org
Subject svn commit: r657629 - in /commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math: genetics/ stat/descriptive/ stat/descriptive/moment/ stat/descriptive/rank/ stat/descriptive/summary/ stat/inference/ stat/regression/
Date Sun, 18 May 2008 20:21:24 GMT
Author: luc
Date: Sun May 18 13:21:23 2008
New Revision: 657629

URL: http://svn.apache.org/viewvc?rev=657629&view=rev
Log:
fixed many checkstyle errors about javadoc

Modified:
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Chromosome.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/ChromosomePair.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/CrossoverPolicy.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/GeneticAlgorithm.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/MutationPolicy.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Population.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/SelectionPolicy.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/StoppingCondition.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SummaryStatistics.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedMultivariateSummaryStatistics.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedSummaryStatistics.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/ThirdMoment.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Max.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Min.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Product.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfLogs.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfSquares.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/inference/OneWayAnovaImpl.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/AbstractMultipleLinearRegression.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/MultipleLinearRegression.java
    commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Chromosome.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Chromosome.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Chromosome.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Chromosome.java Sun May 18 13:21:23 2008
@@ -18,6 +18,7 @@
 
 /**
  * Individual in a population. Chromosomes are compared based on their fitness.
+ * @version $Revision$ $Date$
  */
 public interface Chromosome {
     /**

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/ChromosomePair.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/ChromosomePair.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/ChromosomePair.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/ChromosomePair.java Sun May 18 13:21:23 2008
@@ -18,6 +18,7 @@
 
 /**
  * A pair of {@link Chromosome} objects.
+ * @version $Revision$ $Date$
  */
 public class ChromosomePair {
     /** the first chromosome in the pair. */

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/CrossoverPolicy.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/CrossoverPolicy.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/CrossoverPolicy.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/CrossoverPolicy.java Sun May 18 13:21:23 2008
@@ -19,6 +19,7 @@
 /**
  * Policy used to create a pair of new chromosomes by performing a crossover
  * operation on a source pair of chromosomes.
+ * @version $Revision$ $Date$
  */
 public interface CrossoverPolicy {
     /**

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/GeneticAlgorithm.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/GeneticAlgorithm.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/GeneticAlgorithm.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/GeneticAlgorithm.java Sun May 18 13:21:23 2008
@@ -19,6 +19,7 @@
 /**
  * Implementation of a genetic algorithm. All factors that govern the operation
  * of the algorithm can be configured for a specific problem.
+ * @version $Revision$ $Date$
  */
 public class GeneticAlgorithm {
     /** the crossover policy used by the algorithm. */

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/MutationPolicy.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/MutationPolicy.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/MutationPolicy.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/MutationPolicy.java Sun May 18 13:21:23 2008
@@ -18,6 +18,7 @@
 
 /**
  * Algorithm used to mutate a chrommosome.
+ * @version $Revision$ $Date$
  */
 public interface MutationPolicy {
 

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Population.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Population.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Population.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/Population.java Sun May 18 13:21:23 2008
@@ -18,6 +18,7 @@
 
 /**
  * A collection of chromosomes that facilitates generational evolution.
+ * @version $Revision$ $Date$
  */
 public interface Population {
     /**

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/SelectionPolicy.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/SelectionPolicy.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/SelectionPolicy.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/SelectionPolicy.java Sun May 18 13:21:23 2008
@@ -18,6 +18,7 @@
 
 /**
  * Algorithm used to select a chromosome pair from a population.
+ * @version $Revision$ $Date$
  */
 public interface SelectionPolicy {
     /**

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/StoppingCondition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/StoppingCondition.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/StoppingCondition.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/genetics/StoppingCondition.java Sun May 18 13:21:23 2008
@@ -18,6 +18,7 @@
 
 /**
  * Algorithm used to determine when to stop evolution.
+ * @version $Revision$ $Date$
  */
 public interface StoppingCondition {
     /**

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java Sun May 18 13:21:23 2008
@@ -51,7 +51,8 @@
      * input array.</p>
      * <p>
      * If the array is null, an IllegalArgumentException is thrown.</p>
-     * 
+     * @param values input array
+     * @return the value of the statistic applied to the input array
      * @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[])
      */
     public double evaluate(final double[] values) {
@@ -76,7 +77,10 @@
      * <p>
      * If the array is null or the index parameters are not valid, an 
      * IllegalArgumentException is thrown.</p>
-     * 
+     * @param values the input array
+     * @param begin the index of the first element to include
+     * @param length the number of elements to include
+     * @return the value of the statistic applied to the included array entries
      * @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[], int, int)
      */
     public double evaluate(final double[] values, final int begin, final int length) {
@@ -88,17 +92,17 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public abstract void clear();
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public abstract double getResult();
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public abstract void increment(final double d);
     

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java Sun May 18 13:21:23 2008
@@ -38,7 +38,7 @@
     private static final long serialVersionUID = -8007759382851708045L;
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[])
+     * {@inheritDoc}
      */
     public double evaluate(final double[] values) {
         test(values, 0, 0);
@@ -46,7 +46,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[], int, int)
+     * {@inheritDoc}
      */
     public abstract double evaluate(final double[] values, final int begin, final int length);
 

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SummaryStatistics.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SummaryStatistics.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SummaryStatistics.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SummaryStatistics.java Sun May 18 13:21:23 2008
@@ -1,15 +1,18 @@
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with this
- * work for additional information regarding copyright ownership. The ASF
- * licenses this file to You under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law
- * or agreed to in writing, software distributed under the License is
- * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package org.apache.commons.math.stat.descriptive;
 
@@ -48,8 +51,7 @@
  * {@link SynchronizedSummaryStatistics} if concurrent access from multiple
  * threads is required.
  * </p>
- * @version $Revision$ $Date: 2008-02-10 13:28:59 -0600 (Sun, 10 Feb
- *          2008) $
+ * @version $Revision$ $Date$
  */
 public class SummaryStatistics implements StatisticalSummary, Serializable {
 
@@ -330,9 +332,14 @@
             return false;
         }
         SummaryStatistics stat = (SummaryStatistics)object;
-        return (MathUtils.equals(stat.getGeometricMean(), this.getGeometricMean()) && MathUtils.equals(stat.getMax(), this.getMax())
-            && MathUtils.equals(stat.getMean(), this.getMean()) && MathUtils.equals(stat.getMin(), this.getMin()) && MathUtils.equals(stat.getN(), this.getN())
-            && MathUtils.equals(stat.getSum(), this.getSum()) && MathUtils.equals(stat.getSumsq(), this.getSumsq()) && MathUtils.equals(stat.getVariance(),
+        return (MathUtils.equals(stat.getGeometricMean(), this.getGeometricMean()) &&
+                MathUtils.equals(stat.getMax(), this.getMax()) &&
+                MathUtils.equals(stat.getMean(), this.getMean()) &&
+                MathUtils.equals(stat.getMin(), this.getMin()) &&
+                MathUtils.equals(stat.getN(), this.getN()) &&
+                MathUtils.equals(stat.getSum(), this.getSum()) &&
+                MathUtils.equals(stat.getSumsq(), this.getSumsq()) &&
+                MathUtils.equals(stat.getVariance(),
             this.getVariance()));
     }
 

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedDescriptiveStatistics.java Sun May 18 13:21:23 2008
@@ -50,7 +50,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.DescriptiveStatistics#addValue(double)
+     * {@inheritDoc}
      */
     public synchronized void addValue(double v) {
         super.addValue(v);
@@ -66,21 +66,21 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.DescriptiveStatistics#clear()
+     * {@inheritDoc}
      */
     public synchronized void clear() {
         super.clear();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.DescriptiveStatistics#getElement(int)
+     * {@inheritDoc}
      */
     public synchronized double getElement(int index) {
         return super.getElement(index);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.DescriptiveStatistics#getN()
+     * {@inheritDoc}
      */
     public synchronized long getN() {
         return super.getN();
@@ -96,7 +96,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.DescriptiveStatistics#getValues()
+     * {@inheritDoc}
      */
     public synchronized double[] getValues() {
         return super.getValues();
@@ -111,7 +111,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.DescriptiveStatistics#setWindowSize(int)
+     * {@inheritDoc}
      */
     public synchronized void setWindowSize(int windowSize) {
         super.setWindowSize(windowSize);

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedMultivariateSummaryStatistics.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedMultivariateSummaryStatistics.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedMultivariateSummaryStatistics.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedMultivariateSummaryStatistics.java Sun May 18 13:21:23 2008
@@ -49,7 +49,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#addValue(double[])
+     * {@inheritDoc}
      */
     public synchronized void addValue(double[] value)
       throws DimensionMismatchException {
@@ -57,119 +57,119 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getDimension()
+     * {@inheritDoc}
      */
     public synchronized int getDimension() {
         return super.getDimension();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getN()
+     * {@inheritDoc}
      */
     public synchronized long getN() {
         return super.getN();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getSum()
+     * {@inheritDoc}
      */
     public synchronized double[] getSum() {
         return super.getSum();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getSumSq()
+     * {@inheritDoc}
      */
     public synchronized double[] getSumSq() {
         return super.getSumSq();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getSumLog()
+     * {@inheritDoc}
      */
     public synchronized double[] getSumLog() {
         return super.getSumLog();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getMean()
+     * {@inheritDoc}
      */
     public synchronized double[] getMean() {
         return super.getMean();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getStandardDeviation()
+     * {@inheritDoc}
      */
     public synchronized double[] getStandardDeviation() {
         return super.getStandardDeviation();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getCovariance()
+     * {@inheritDoc}
      */
     public synchronized RealMatrix getCovariance() {
         return super.getCovariance();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getMax()
+     * {@inheritDoc}
      */
     public synchronized double[] getMax() {
         return super.getMax();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getMin()
+     * {@inheritDoc}
      */
     public synchronized double[] getMin() {
         return super.getMin();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getGeometricMean()
+     * {@inheritDoc}
      */
     public synchronized double[] getGeometricMean() {
         return super.getGeometricMean();
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#toString()
+     * {@inheritDoc}
      */
     public synchronized String toString() {
         return super.toString();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#clear()
+     * {@inheritDoc}
      */
     public synchronized void clear() {
         super.clear();
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#equals(Object)
+     * {@inheritDoc}
      */
     public synchronized boolean equals(Object object) {
         return super.equals(object);
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#hashCode()
+     * {@inheritDoc}
      */
     public synchronized int hashCode() {
         return super.hashCode();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getSumImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getSumImpl() {
         return super.getSumImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setSumImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setSumImpl(StorelessUnivariateStatistic[] sumImpl)
       throws DimensionMismatchException {
@@ -177,14 +177,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getSumsqImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getSumsqImpl() {
         return super.getSumsqImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setSumsqImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setSumsqImpl(StorelessUnivariateStatistic[] sumsqImpl)
       throws DimensionMismatchException {
@@ -192,14 +192,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getMinImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getMinImpl() {
         return super.getMinImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setMinImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setMinImpl(StorelessUnivariateStatistic[] minImpl)
       throws DimensionMismatchException {
@@ -207,14 +207,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getMaxImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getMaxImpl() {
         return super.getMaxImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setMaxImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setMaxImpl(StorelessUnivariateStatistic[] maxImpl)
       throws DimensionMismatchException {
@@ -222,14 +222,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getSumLogImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getSumLogImpl() {
         return super.getSumLogImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setSumLogImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setSumLogImpl(StorelessUnivariateStatistic[] sumLogImpl)
       throws DimensionMismatchException {
@@ -237,14 +237,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getGeoMeanImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getGeoMeanImpl() {
         return super.getGeoMeanImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setGeoMeanImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setGeoMeanImpl(StorelessUnivariateStatistic[] geoMeanImpl)
       throws DimensionMismatchException {
@@ -252,14 +252,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#getMeanImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic[] getMeanImpl() {
         return super.getMeanImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.MultivariateSummaryStatistics#setMeanImpl(StorelessUnivariateStatistic[])
+     * {@inheritDoc}
      */
     public synchronized void setMeanImpl(StorelessUnivariateStatistic[] meanImpl)
       throws DimensionMismatchException {

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedSummaryStatistics.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedSummaryStatistics.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedSummaryStatistics.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/SynchronizedSummaryStatistics.java Sun May 18 13:21:23 2008
@@ -42,217 +42,217 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getSummary()
+     * {@inheritDoc}
      */
     public synchronized StatisticalSummary getSummary() {
         return super.getSummary();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#addValue(double)
+     * {@inheritDoc}
      */
     public synchronized void addValue(double value) {
         super.addValue(value);
     }
 
     /** 
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getN()
+     * {@inheritDoc}
      */
     public synchronized long getN() {
         return super.getN();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getSum()
+     * {@inheritDoc}
      */
     public synchronized double getSum() {
         return super.getSum();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getSumsq()
+     * {@inheritDoc}
      */
     public synchronized double getSumsq() {
         return super.getSumsq();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getMean()
+     * {@inheritDoc}
      */
     public synchronized double getMean() {
         return super.getMean();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getStandardDeviation()
+     * {@inheritDoc}
      */
     public synchronized double getStandardDeviation() {
         return super.getStandardDeviation();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getVariance()
+     * {@inheritDoc}
      */
     public synchronized double getVariance() {
         return super.getVariance();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getMax()
+     * {@inheritDoc}
      */
     public synchronized double getMax() {
         return super.getMax();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getMin()
+     * {@inheritDoc}
      */
     public synchronized double getMin() {
         return super.getMin();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getGeometricMean()
+     * {@inheritDoc}
      */
     public synchronized double getGeometricMean() {
         return super.getGeometricMean();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#toString()
+     * {@inheritDoc}
      */
     public synchronized String toString() {
         return super.toString();
     }
 
     /** 
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#clear()
+     * {@inheritDoc}
      */
     public synchronized void clear() {
         super.clear();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#equals(Object)
+     * {@inheritDoc}
      */
     public synchronized boolean equals(Object object) {
         return super.equals(object);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#hashCode()
+     * {@inheritDoc}
      */
     public synchronized int hashCode() {
         return super.hashCode();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getSumImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getSumImpl() {
         return super.getSumImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setSumImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setSumImpl(StorelessUnivariateStatistic sumImpl) {
         super.setSumImpl(sumImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getSumsqImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getSumsqImpl() {
         return super.getSumsqImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setSumsqImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setSumsqImpl(StorelessUnivariateStatistic sumsqImpl) {
         super.setSumsqImpl(sumsqImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getMinImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getMinImpl() {
         return super.getMinImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setMinImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setMinImpl(StorelessUnivariateStatistic minImpl) {
         super.setMinImpl(minImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getMaxImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getMaxImpl() {
         return super.getMaxImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setMaxImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setMaxImpl(StorelessUnivariateStatistic maxImpl) {
         super.setMaxImpl(maxImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getSumLogImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getSumLogImpl() {
         return super.getSumLogImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setSumLogImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setSumLogImpl(StorelessUnivariateStatistic sumLogImpl) {
         super.setSumLogImpl(sumLogImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getGeoMeanImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getGeoMeanImpl() {
         return super.getGeoMeanImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setGeoMeanImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setGeoMeanImpl(StorelessUnivariateStatistic geoMeanImpl) {
         super.setGeoMeanImpl(geoMeanImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getMeanImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getMeanImpl() {
         return super.getMeanImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setMeanImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setMeanImpl(StorelessUnivariateStatistic meanImpl) {
         super.setMeanImpl(meanImpl);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#getVarianceImpl()
+     * {@inheritDoc}
      */
     public synchronized StorelessUnivariateStatistic getVarianceImpl() {
         return super.getVarianceImpl();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.SummaryStatistics#setVarianceImpl(StorelessUnivariateStatistic)
+     * {@inheritDoc}
      */
     public synchronized void setVarianceImpl(StorelessUnivariateStatistic varianceImpl) {
         super.setVarianceImpl(varianceImpl);

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java Sun May 18 13:21:23 2008
@@ -81,7 +81,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n == 0) {
@@ -95,7 +95,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         m1 = Double.NaN;
@@ -105,14 +105,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return m1;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java Sun May 18 13:21:23 2008
@@ -67,7 +67,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n < 1) {
@@ -89,14 +89,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return m4;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         super.clear();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java Sun May 18 13:21:23 2008
@@ -61,20 +61,21 @@
     
     /**
      * Create a GeometricMean instance using the given SumOfLogs instance
+     * @param sumOfLogs sum of logs instance to use for computation
      */
     public GeometricMean(SumOfLogs sumOfLogs) {
         this.sumOfLogs = sumOfLogs;
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         sumOfLogs.increment(d);
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         if (sumOfLogs.getN() > 0) {
@@ -85,7 +86,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         sumOfLogs.clear();
@@ -114,7 +115,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return sumOfLogs.getN();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java Sun May 18 13:21:23 2008
@@ -73,7 +73,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (incMoment) {
@@ -85,7 +85,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         double kurtosis = Double.NaN;
@@ -105,7 +105,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         if (incMoment) {
@@ -117,7 +117,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return moment.getN();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java Sun May 18 13:21:23 2008
@@ -89,7 +89,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (incMoment) {
@@ -98,7 +98,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         if (incMoment) {
@@ -107,14 +107,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return moment.m1;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return moment.getN();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java Sun May 18 13:21:23 2008
@@ -59,7 +59,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n < 1) {
@@ -70,7 +70,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         super.clear();
@@ -78,7 +78,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return m2;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java Sun May 18 13:21:23 2008
@@ -71,7 +71,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (incMoment) {
@@ -102,14 +102,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return moment.getN();
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         if (incMoment) {

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java Sun May 18 13:21:23 2008
@@ -93,28 +93,28 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         variance.increment(d);
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return variance.getN();
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return Math.sqrt(variance.getResult());
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         variance.clear();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/ThirdMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/ThirdMoment.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/ThirdMoment.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/ThirdMoment.java Sun May 18 13:21:23 2008
@@ -68,7 +68,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n < 1) {
@@ -83,14 +83,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return m3;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         super.clear();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Variance.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Variance.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/moment/Variance.java Sun May 18 13:21:23 2008
@@ -147,7 +147,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
             if (moment.n == 0) {
@@ -164,14 +164,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return moment.getN();
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         if (incMoment) {

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Max.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Max.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Max.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Max.java Sun May 18 13:21:23 2008
@@ -55,7 +55,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (d > value || Double.isNaN(value)) {
@@ -65,7 +65,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         value = Double.NaN;
@@ -73,14 +73,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return value;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Min.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Min.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Min.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/rank/Min.java Sun May 18 13:21:23 2008
@@ -57,7 +57,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (d < value || Double.isNaN(value)) {
@@ -67,7 +67,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         value = Double.NaN;
@@ -75,14 +75,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return value;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Product.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Product.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Product.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Product.java Sun May 18 13:21:23 2008
@@ -55,7 +55,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n == 0) {
@@ -67,21 +67,21 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return value;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         value = Double.NaN;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Sum.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Sum.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/Sum.java Sun May 18 13:21:23 2008
@@ -55,7 +55,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n == 0) {
@@ -67,21 +67,21 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return value;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         value = Double.NaN;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfLogs.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfLogs.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfLogs.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfLogs.java Sun May 18 13:21:23 2008
@@ -63,7 +63,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         value += Math.log(d);
@@ -71,7 +71,7 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         if (n > 0) {
@@ -82,14 +82,14 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         value = 0d;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfSquares.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfSquares.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfSquares.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfSquares.java Sun May 18 13:21:23 2008
@@ -55,7 +55,7 @@
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#increment(double)
+     * {@inheritDoc}
      */
     public void increment(final double d) {
         if (n == 0) {
@@ -67,21 +67,21 @@
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getResult()
+     * {@inheritDoc}
      */
     public double getResult() {
         return value;
     }
 
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#getN()
+     * {@inheritDoc}
      */
     public long getN() {
         return n;
     }
     
     /**
-     * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#clear()
+     * {@inheritDoc}
      */
     public void clear() {
         value = Double.NaN;

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/inference/OneWayAnovaImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/inference/OneWayAnovaImpl.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/inference/OneWayAnovaImpl.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/inference/OneWayAnovaImpl.java Sun May 18 13:21:23 2008
@@ -178,8 +178,14 @@
         No get/set methods provided.
     */
     private static class AnovaStats {
+
+        /** Degrees of freedom in numerator (between groups). */
         private int dfbg;
+
+        /** Degrees of freedom in denominator (within groups). */
         private int dfwg;
+
+        /** Statistic. */
         private double F;
 
         /**

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/AbstractMultipleLinearRegression.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/AbstractMultipleLinearRegression.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/AbstractMultipleLinearRegression.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/AbstractMultipleLinearRegression.java Sun May 18 13:21:23 2008
@@ -21,11 +21,16 @@
 
 /**
  * Abstract base class for implementations of MultipleLinearRegression.
+ * @version $Revision$ $Date$
+ * @since 2.0
  */
 public abstract class AbstractMultipleLinearRegression implements
         MultipleLinearRegression {
 
+    /** X sample data. */
     protected RealMatrix X;
+
+    /** Y sample data. */
     protected RealMatrix Y;
 
     /**
@@ -46,37 +51,52 @@
         this.X = new RealMatrixImpl(x);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public double[] estimateRegressionParameters(){
         RealMatrix b = calculateBeta();
         return b.getColumn(0);
     }    
     
+    /**
+     * {@inheritDoc}
+     */
     public double[] estimateResiduals(){
         RealMatrix b = calculateBeta();
         RealMatrix e = Y.subtract(X.multiply(b));
         return e.getColumn(0);
     }
-    
+
+    /**
+     * {@inheritDoc}
+     */
     public double[][] estimateRegressionParametersVariance() {
         return calculateBetaVariance().getData();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public double estimateRegressandVariance() {
         return calculateYVariance();
     }
     
     /**
      * Calculates the beta of multiple linear regression in matrix notation.
+     * @return beta
      */
     protected abstract RealMatrix calculateBeta();    
     
     /**
      * Calculates the beta variance of multiple linear regression in matrix notation.
+     * @return beta variance
      */
     protected abstract RealMatrix calculateBetaVariance();
     
     /**
      * Calculates the Y variance of multiple linear regression.
+     * @return Y variance
      */
     protected abstract double calculateYVariance();
 

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/GLSMultipleLinearRegression.java Sun May 18 13:21:23 2008
@@ -36,12 +36,17 @@
  * <pre>
  * Var(b)=(X' Omega^-1 X)^-1
  * </pre>
+ * @version $Revision$ $Date$
+ * @since 2.0
  */
 public class GLSMultipleLinearRegression extends AbstractMultipleLinearRegression {
     
+    /** Covariance matrix. */
     private RealMatrix Omega;
-    
 
+    /**
+     * {@inheritDoc}
+     */
     public void addData(double[] y, double[][] x, double[][] covariance) {
         addYSampleData(y);
         addXSampleData(x);
@@ -61,7 +66,8 @@
      * Calculates beta by GLS.
      * <pre>
      *  b=(X' Omega^-1 X)^-1X'Omega^-1 y
-     * </pre> 
+     * </pre>
+     * @return beta
      */
     protected RealMatrix calculateBeta() {
         RealMatrix OI = Omega.inverse();

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/MultipleLinearRegression.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/MultipleLinearRegression.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/MultipleLinearRegression.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/MultipleLinearRegression.java Sun May 18 13:21:23 2008
@@ -27,6 +27,8 @@
  * 
  * The notation is quite standard in literature, 
  * cf eg <a href="http://www.econ.queensu.ca/ETM">Davidson and MacKinnon, Econometrics Theory and Methods, 2004</a>.
+ * @version $Revision$ $Date$
+ * @since 2.0
  */
 public interface MultipleLinearRegression {
 

Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java?rev=657629&r1=657628&r2=657629&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java Sun May 18 13:21:23 2008
@@ -35,10 +35,14 @@
  * <pre>
  * Var(b)=MSE*(X'X)^-1, MSE=u'u/(n-k)
  * </pre>
+ * @version $Revision$ $Date$
+ * @since 2.0
  */
 public class OLSMultipleLinearRegression extends AbstractMultipleLinearRegression {
-    
 
+    /**
+     * {@inheritDoc}
+     */
     public void addData(double[] y, double[][] x, double[][] covariance) {
         addYSampleData(y);
         addXSampleData(x);
@@ -49,6 +53,7 @@
      * <pre>
      * b=(X'X)^-1X'y
      * </pre> 
+     * @return beta
      */
     protected RealMatrix calculateBeta() {
         RealMatrix XTX = X.transpose().multiply(X);



Mime
View raw message