Touched up the javadoc comments.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@141197 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/math/analysis/NewtonSolver.java

@@ -22,12 +22,12 @@ import java.io.Serializable;
 import org.apache.commons.math.MathException;
 
 /**
- * Implements <a href="http://mathworld.wolfram.com/NewtonsMethod.html">\
+ * Implements <a href="http://mathworld.wolfram.com/NewtonsMethod.html">
  * Newton's Method</a> for finding zeros of real univariate functions. This
  * algorithm will find only one zero in the given interval.  The function should
  * be continuous but not necessarily smooth.
  *
- * @version $Revision: 1.1 $ $Date: 2004/04/08 21:19:17 $
+ * @version $Revision: 1.2 $ $Date: 2004/04/26 19:15:48 $
  */
 public class NewtonSolver extends UnivariateRealSolverImpl implements Serializable {
     

src/java/org/apache/commons/math/distribution/BinomialDistribution.java

@@ -17,17 +17,19 @@ package org.apache.commons.math.distribution;
 
 /**
  * The Binomial Distribution.
- * 
+ *
  * Instances of BinomialDistribution objects should be created using
  * {@link DistributionFactory#createBinomialDistribution(int, double)}.
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/BinomialDistribution.html">
  * Binomial Distribution</a></li>
  * </ul>
+ * </p>
  * 
- * @version $Revision: 1.9 $ $Date: 2004/02/21 21:35:14 $
+ * @version $Revision: 1.10 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface BinomialDistribution extends DiscreteDistribution {
     /**

src/java/org/apache/commons/math/distribution/ChiSquaredDistribution.java

@@ -21,13 +21,15 @@ package org.apache.commons.math.distribution;
  * Instances of ChiSquaredDistribution objects should be created using
  * {@link DistributionFactory#createChiSquareDistribution(double)}.
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/Chi-SquaredDistribution.html">
  * Chi-Squared Distribution</a></li>
  * </ul>
+ * </p>
  * 
- * @version $Revision: 1.12 $ $Date: 2004/02/21 21:35:14 $
+ * @version $Revision: 1.13 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface ChiSquaredDistribution extends ContinuousDistribution {
     /**

src/java/org/apache/commons/math/distribution/ExponentialDistribution.java

@@ -21,12 +21,15 @@ package org.apache.commons.math.distribution;
  * Instances of ExponentialDistribution objects should be created using
  * {@link DistributionFactory#createExponentialDistribution(double)}.
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/ExponentialDistribution.html">
  * Exponential Distribution</a></li>
+ * </ul>
+ * </p>
  * 
- * @version $Revision: 1.10 $ $Date: 2004/02/21 21:35:14 $
+ * @version $Revision: 1.11 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface ExponentialDistribution extends ContinuousDistribution {
     /**

src/java/org/apache/commons/math/distribution/FDistribution.java

@@ -21,13 +21,15 @@ package org.apache.commons.math.distribution;
  * Instances of FDistribution objects should be created using
  * {@link DistributionFactory#createFDistribution(double,double)}.
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/F-Distribution.html">
  * F-Distribution</a></li>
  * </ul>
+ * </p>
  * 
- * @version $Revision: 1.11 $ $Date: 2004/02/21 21:35:14 $
+ * @version $Revision: 1.12 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface FDistribution extends ContinuousDistribution {
     /**

src/java/org/apache/commons/math/distribution/GammaDistribution.java

@@ -21,13 +21,15 @@ package org.apache.commons.math.distribution;
  * Instances of GammaDistribution objects should be created using
  * {@link DistributionFactory#createGammaDistribution(double,double)}.
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/GammaDistribution.html">
  * Gamma Distribution</a></li>
  * </ul>
- *  
- * @version $Revision: 1.13 $ $Date: 2004/02/21 21:35:14 $
+ * </p>
+ * 
+ * @version $Revision: 1.14 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface GammaDistribution extends ContinuousDistribution {
     /**

src/java/org/apache/commons/math/distribution/HypergeometricDistribution.java

@@ -22,13 +22,15 @@ package org.apache.commons.math.distribution;
  * Instances of HypergeometricDistribution objects should be created using
  * {@link DistributionFactory#createHypergeometricDistribution(int, int, int)}.
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/HypergeometricDistribution.html">
  * Hypergeometric Distribution</a></li>
  * </ul>
+ * </p>
  * 
- * @version $Revision: 1.8 $ $Date: 2004/02/21 21:35:14 $
+ * @version $Revision: 1.9 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface HypergeometricDistribution extends DiscreteDistribution {
     /**

src/java/org/apache/commons/math/distribution/NormalDistribution.java

@@ -21,12 +21,15 @@ package org.apache.commons.math.distribution;
  * Instances of NormalDistribution objects should be created using
  * {@link DistributionFactory#createNormalDistribution(double, double)}.<p>
  * 
+ * <p>
  * References:<p>
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/NormalDistribution.html">
  * Normal Distribution</a></li>
  * </ul>
+ * </p>
  * 
+ * @version $Revision: 1.4 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface NormalDistribution extends ContinuousDistribution {
 	/**

src/java/org/apache/commons/math/distribution/TDistribution.java

@@ -21,13 +21,15 @@ package org.apache.commons.math.distribution;
  * Instances of TDistribution objects should be created using
  * {@link DistributionFactory#createTDistribution(double)}
  * 
+ * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/Studentst-Distribution.html">
  * Student's t-Distribution</a></li>
  * </ul>
+ * </p>
  * 
- * @version $Revision: 1.10 $ $Date: 2004/02/21 21:35:14 $
+ * @version $Revision: 1.11 $ $Date: 2004/04/26 19:15:48 $
  */
 public interface TDistribution extends ContinuousDistribution {
     /**

src/java/org/apache/commons/math/random/EmpiricalDistributionImpl.java

@@ -51,9 +51,9 @@ import org.apache.commons.math.stat.univariate.SummaryStatistics;
  *    by 10.  See TODO: add reference </li>
  *<li>The input file <i>must</i> be a plain text file containing one valid numeric
  *    entry per line.</li>
- * </ol></p>
+ * </ul></p>
  *
- * @version $Revision: 1.18 $ $Date: 2004/04/12 02:27:49 $
+ * @version $Revision: 1.19 $ $Date: 2004/04/26 19:15:48 $
  */
 public class EmpiricalDistributionImpl implements Serializable, EmpiricalDistribution {
 

src/java/org/apache/commons/math/stat/univariate/DescriptiveStatisticsImpl.java

@@ -22,7 +22,10 @@ import java.util.Arrays;
 import org.apache.commons.math.util.ContractableDoubleArray;
 
 /**
- * @version $Revision: 1.2 $ $Date: 2004/04/23 19:50:27 $
+ * Default implementation of
+ * {@link org.apache.commons.math.stat.univariate.DescriptiveStatistics}.
+ * 
+ * @version $Revision: 1.3 $ $Date: 2004/04/26 19:15:48 $
  */
 public class DescriptiveStatisticsImpl extends AbstractDescriptiveStatistics implements Serializable {
 

src/java/org/apache/commons/math/stat/univariate/rank/Max.java

@@ -26,7 +26,9 @@ import org
     .AbstractStorelessUnivariateStatistic;
 
 /**
- * @version $Revision: 1.14 $ $Date: 2004/02/21 21:35:16 $
+ * Returns the maximum of the available values.
+ * 
+ * @version $Revision: 1.15 $ $Date: 2004/04/26 19:15:48 $
  */
 public class Max extends AbstractStorelessUnivariateStatistic implements Serializable {
 
@@ -69,6 +71,8 @@ public class Max extends AbstractStorelessUnivariateStatistic implements Seriali
     }
     
     /**
+     * Returns the maximum of the available values.
+     * 
      * @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
      */
     public double evaluate(

src/java/org/apache/commons/math/stat/univariate/rank/Median.java

@@ -19,14 +19,17 @@ import java.io.Serializable;
 
 
 /**
- * @version $Revision: 1.11 $ $Date: 2004/02/21 21:35:16 $
+ * Returns the <a href="http://www.xycoon.com/median_2.htm">median</a> of the
+ * available values.
+ * 
+ * @version $Revision: 1.12 $ $Date: 2004/04/26 19:15:48 $
  */
 public class Median extends Percentile implements Serializable {
 
     static final long serialVersionUID = -3961477041290915687L;    
 
     /**
-     *
+     * Default constructor.
      */
     public Median() {
         super(50.0);

src/java/org/apache/commons/math/stat/univariate/rank/Min.java

@@ -26,7 +26,9 @@ import org
     .AbstractStorelessUnivariateStatistic;
 
 /**
- * @version $Revision: 1.14 $ $Date: 2004/02/21 21:35:16 $
+ * Returns the minimum of the available values.
+ * 
+ * @version $Revision: 1.15 $ $Date: 2004/04/26 19:15:48 $
  */
 public class Min extends AbstractStorelessUnivariateStatistic implements Serializable {
 
@@ -69,6 +71,8 @@ public class Min extends AbstractStorelessUnivariateStatistic implements Seriali
     }
     
     /**
+     * Returns the minimum of the available values.
+     * 
      * @see org.apache.commons.math.stat.univariate.UnivariateStatistic#evaluate(double[], int, int)
      */
     public double evaluate(

src/java/org/apache/commons/math/stat/univariate/rank/Percentile.java

@@ -28,7 +28,7 @@ import org.apache.commons.math.stat.univariate.AbstractUnivariateStatistic;
  * follows the first estimation procedure presented
  * <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a>
  * 
- * @version $Revision: 1.16 $ $Date: 2004/03/21 21:57:19 $
+ * @version $Revision: 1.17 $ $Date: 2004/04/26 19:15:48 $
  */
 public class Percentile extends AbstractUnivariateStatistic implements Serializable {
 
@@ -42,8 +42,7 @@ public class Percentile extends AbstractUnivariateStatistic implements Serializa
      * value of 50.0.
      */
     public Percentile() {
-        super();
-        quantile = 50.0;
+        this(50.0);
     }
 
     /**

src/java/org/apache/commons/math/stat/univariate/summary/Product.java

@@ -26,7 +26,9 @@ import org
     .AbstractStorelessUnivariateStatistic;
 
 /**
- * @version $Revision: 1.15 $ $Date: 2004/03/04 04:25:09 $
+ * Returns the product for this collection of values.
+ * 
+ * @version $Revision: 1.16 $ $Date: 2004/04/26 19:15:48 $
  */
 public class Product extends AbstractStorelessUnivariateStatistic implements Serializable {
 

src/java/org/apache/commons/math/stat/univariate/summary/Sum.java

@@ -20,7 +20,9 @@ import java.io.Serializable;
 import org.apache.commons.math.stat.univariate.AbstractStorelessUnivariateStatistic;
 
 /**
- * @version $Revision: 1.17 $ $Date: 2004/03/04 04:25:09 $
+ * The sum of the values that have been added to Univariate.
+ * 
+ * @version $Revision: 1.18 $ $Date: 2004/04/26 19:15:48 $
  */
 public class Sum extends AbstractStorelessUnivariateStatistic implements Serializable {
 

src/java/org/apache/commons/math/stat/univariate/summary/SumOfLogs.java

@@ -26,7 +26,9 @@ import org
     .AbstractStorelessUnivariateStatistic;
 
 /**
- * @version $Revision: 1.15 $ $Date: 2004/03/04 04:25:09 $
+ * Returns the sum of the natural logs for this collection of values.
+ * 
+ * @version $Revision: 1.16 $ $Date: 2004/04/26 19:15:48 $
  */
 public class SumOfLogs extends AbstractStorelessUnivariateStatistic implements Serializable {
 

src/java/org/apache/commons/math/stat/univariate/summary/SumOfSquares.java

@@ -26,7 +26,9 @@ import org
     .AbstractStorelessUnivariateStatistic;
 
 /**
- * @version $Revision: 1.15 $ $Date: 2004/03/04 04:25:09 $
+ * Returns the sum of the squares of the available values.
+ * 
+ * @version $Revision: 1.16 $ $Date: 2004/04/26 19:15:48 $
  */
 public class SumOfSquares extends AbstractStorelessUnivariateStatistic implements Serializable {