commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject cvs commit: jakarta-commons/math/src/java/org/apache/commons/math/stat BivariateRegression.java DescriptiveStatistics.java StatUtils.java TestStatistic.java
Date Sun, 11 Apr 2004 19:00:45 GMT
psteitz     2004/04/11 12:00:45

  Modified:    math/src/java/org/apache/commons/math/linear RealMatrix.java
                        RealMatrixImpl.java
               math/src/java/org/apache/commons/math/random RandomData.java
                        RandomDataImpl.java
               math/src/java/org/apache/commons/math/stat
                        BivariateRegression.java DescriptiveStatistics.java
                        StatUtils.java TestStatistic.java
  Log:
  Javadoc. Fixed broken / malformed links.
  
  Revision  Changes    Path
  1.15      +3 -4      jakarta-commons/math/src/java/org/apache/commons/math/linear/RealMatrix.java
  
  Index: RealMatrix.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/linear/RealMatrix.java,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- RealMatrix.java	8 Apr 2004 07:02:55 -0000	1.14
  +++ RealMatrix.java	11 Apr 2004 19:00:45 -0000	1.15
  @@ -107,9 +107,8 @@
       void setData(double[][] data);
       
       /**
  -     * Returns the <a href="http://mathworld.wolfram.com/
  -     * MaximumAbsoluteRowSumNorm.html">maximum absolute row sum norm</a> 
  -     * of the matrix.
  +     * Returns the <a href="http://mathworld.wolfram.com/MaximumAbsoluteRowSumNorm.html">
  +     * maximum absolute row sum norm</a> of the matrix.
        *
        * @return norm
        */
  
  
  
  1.18      +9 -12     jakarta-commons/math/src/java/org/apache/commons/math/linear/RealMatrixImpl.java
  
  Index: RealMatrixImpl.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/linear/RealMatrixImpl.java,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- RealMatrixImpl.java	8 Apr 2004 20:46:01 -0000	1.17
  +++ RealMatrixImpl.java	11 Apr 2004 19:00:45 -0000	1.18
  @@ -21,13 +21,11 @@
   
   /**
    * Implementation for RealMatrix using a double[][] array to store entries
  - * and <a href="http://www.math.gatech.edu/~bourbaki/
  - * math2601/Web-notes/2num.pdf">LU decompostion</a> to support linear system 
  + * and <a href="http://www.math.gatech.edu/~bourbaki/math2601/Web-notes/2num.pdf">
  + * LU decompostion</a> to support linear system 
    * solution and inverse.
    * <p>
  - * The <a href="http://www.math.gatech.edu/~bourbaki/math2601/Web-notes
  - * /2num.pdf">LU decompostion</a> is performed as needed, to support the 
  - * following operations: <ul>
  + * The LU decompostion is performed as needed, to support the following operations: <ul>
    * <li>solve</li>
    * <li>isSingular</li>
    * <li>getDeterminant</li>
  @@ -617,14 +615,13 @@
   	}
   
   	/**
  -	 * Computes a new <a href="http://www.math.gatech.edu/~bourbaki/
  -	 * math2601/Web-notes/2num.pdf">LU decompostion</a> for this matrix,
  -	 * storing the result for use by other methods. 
  +	 * Computes a new 
  +	 * <a href="http://www.math.gatech.edu/~bourbaki/math2601/Web-notes/2num.pdf">
  +	 * LU decompostion</a> for this matrix, storing the result for use by other methods.

   	 * <p>
   	 * <strong>Implementation Note</strong>:<br>
  -	 * Uses <a href="http://www.damtp.cam.ac.uk/user/fdl/
  -	 * people/sd/lectures/nummeth98/linear.htm">Crout's algortithm</a>,
  -	 * with partial pivoting.
  +	 * Uses <a href="http://www.damtp.cam.ac.uk/user/fdl/people/sd/lectures/nummeth98/linear.htm">
  +	 * Crout's algortithm</a>, with partial pivoting.
   	 * <p>
   	 * <strong>Usage Note</strong>:<br>
   	 * This method should rarely be invoked directly. Its only use is
  
  
  
  1.9       +9 -17     jakarta-commons/math/src/java/org/apache/commons/math/random/RandomData.java
  
  Index: RandomData.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/random/RandomData.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- RandomData.java	21 Feb 2004 21:35:15 -0000	1.8
  +++ RandomData.java	11 Apr 2004 19:00:45 -0000	1.9
  @@ -107,8 +107,7 @@
        * <code>nextInt</code> should be used instead of this method. 
        * <p>
        * <strong>Definition</strong>:
  -     * <a href="http://www.wikipedia.org/wiki/
  -     * Cryptographically_secure_pseudo-random_number_generator">
  +     * <a href="http://en.wikipedia.org/wiki/Cryptographically_secure_pseudo-random_number_generator">
        * Secure Random Sequence</a>
        * <p>
        * <strong>Preconditions</strong>:<ul>
  @@ -131,8 +130,7 @@
        * <code>nextLong</code> should be used instead of this method.
        * <p>
        * <strong>Definition</strong>:
  -     * <a href="http://www.wikipedia.org/wiki/
  -     * Cryptographically_secure_pseudo-random_number_generator">
  +     * <a href="http://en.wikipedia.org/wiki/Cryptographically_secure_pseudo-random_number_generator">
        * Secure Random Sequence</a>
        * <p>
        * <strong>Preconditions</strong>:<ul>
  @@ -152,8 +150,7 @@
        * the given mean.
        * <p>
        * <strong>Definition</strong>: 
  -     * <a href="http://www.itl.nist.gov/div898/handbook/
  -     * eda/section3/eda366j.htm">
  +     * <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda366j.htm">
        * Poisson Distribution</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
  @@ -171,8 +168,7 @@
        * and standard deviation.
        * <p>
        * <strong>Definition</strong>: 
  -     * <a href="http://www.itl.nist.gov/div898/handbook/
  -     * eda/section3/eda3661.htm">
  +     * <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3661.htm">
        * Normal Distribution</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
  @@ -191,8 +187,7 @@
        * with expected value = <code>mean</code>.
        * <p>
        * <strong>Definition</strong>: 
  -     * <a href="http://www.itl.nist.gov/div898/handbook/
  -     * eda/section3/eda3667.htm">
  +     * <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3667.htm">
        * Exponential Distribution</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
  @@ -209,12 +204,10 @@
        * (<code>lower</code>,<code>upper</code>) (i.e., endpoints
excluded).
        * <p>
        * <strong>Definition</strong>: 
  -     * <a href="http://www.itl.nist.gov/div898/handbook/
  -     * eda/section3/eda3662.htm">
  +     * <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3662.htm">
        * Uniform Distribution</a> <code>lower</code> and 
        * <code>upper - lower</code> are the 
  -     * <a href = "http://www.itl.nist.gov/div898/handbook/eda/
  -     * section3/eda364.htm">
  +     * <a href = "http://www.itl.nist.gov/div898/handbook/eda/section3/eda364.htm">
        * location and scale parameters</a>, respectively.
        * <p>
        * <strong>Preconditions</strong>:<ul>
  @@ -258,8 +251,7 @@
        * is without replacement; but if <code>c</code> contains identical
        * objects, the sample may include repeats.  If all elements of <code>
        * c</code> are distinct, the resulting object array represents a 
  -     * <a href="http://rkb.home.cern.ch/rkb/AN16pp/
  -     * node250.html#SECTION0002500000000000000000">
  +     * <a href="http://rkb.home.cern.ch/rkb/AN16pp/node250.html#SECTION0002500000000000000000">
        * Simple Random Sample</a> of size
        * <code>k</code> from the elements of <code>c</code>.
        * <p>   
  
  
  
  1.13      +5 -6      jakarta-commons/math/src/java/org/apache/commons/math/random/RandomDataImpl.java
  
  Index: RandomDataImpl.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/random/RandomDataImpl.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- RandomDataImpl.java	21 Feb 2004 21:35:15 -0000	1.12
  +++ RandomDataImpl.java	11 Apr 2004 19:00:45 -0000	1.13
  @@ -30,7 +30,7 @@
    * <code>java.util.Random.SecureRandom</code> instances to generate data. 
    * <p>
    * Supports reseeding the underlying 
  - * <a href="http://www.wikipedia.org/wiki/Pseudo-random_number_generator">
  + * <a href="http://en.wikipedia.org/wiki/Pseudorandom_number_generator">
    * PRNG</a>. The <code>SecurityProvider</code> and <code>Algorithm</code>
    * used by the <code>SecureRandom</code> instance can also be reset.
    * <p>
  @@ -46,9 +46,8 @@
    * <strong>one</strong> <code>RandomDataImpl</code> instance repeatedly.</li>
    * <li>
    * The "secure" methods are *much* slower.  These should be used only when
  - * a <a href="http://www.wikipedia.org/wiki/
  - * Cryptographically_secure_pseudo-random_number_generator"> Secure Random 
  - * Sequence</a> is required.</li>
  + * a <a href="http://en.wikipedia.org/wiki/Cryptographically_secure_pseudo-random_number_generator">
  + * Secure Random Sequence</a> is required.</li>
    * <li>
    * When a new <code>RandomDataImpl</code> is created, the underlying random
    * number generators are <strong>not</strong> intialized.  The first call to
a
  @@ -462,7 +461,7 @@
       /**
        * Uses a 2-cycle permutation shuffle to generate a random permutation.
        * The shuffling process is described
  -     * <a href=http://www.maths.abdn.ac.uk/~igc/tch/mx4002/notes/node83.html>
  +     * <a href="http://www.maths.abdn.ac.uk/~igc/tch/mx4002/notes/node83.html">
        * here</a>.
        * @param n the population size.
        * @param k the number to choose.
  
  
  
  1.16      +7 -7      jakarta-commons/math/src/java/org/apache/commons/math/stat/BivariateRegression.java
  
  Index: BivariateRegression.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/BivariateRegression.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- BivariateRegression.java	21 Mar 2004 22:39:56 -0000	1.15
  +++ BivariateRegression.java	11 Apr 2004 19:00:45 -0000	1.16
  @@ -382,8 +382,8 @@
        * <strong>Usage Note</strong>:<br>
        * The validity of this statistic depends on the assumption that the 
        * observations included in the model are drawn from a
  -     * <a href="http://mathworld.wolfram.com/
  -     * BivariateNormalDistribution.html">Bivariate Normal Distribution</a>.
  +     * <a href="http://mathworld.wolfram.com/BivariateNormalDistribution.html">
  +     * Bivariate Normal Distribution</a>.
        *
        * @return half-width of 95% confidence interval for the slope estimate
        */
  @@ -406,8 +406,8 @@
        * <strong>Usage Note</strong>:<br>
        * The validity of this statistic depends on the assumption that the 
        * observations included in the model are drawn from a
  -     * <a href="http://mathworld.wolfram.com/
  -     * BivariateNormalDistribution.html">Bivariate Normal Distribution</a>.
  +     * <a href="http://mathworld.wolfram.com/BivariateNormalDistribution.html">
  +     * Bivariate Normal Distribution</a>.
        * <p>
        * <strong> Preconditions:</strong><ul>
        * <li>If there are fewer that <strong>three</strong> observations
in the 
  @@ -441,8 +441,8 @@
        * <strong>Usage Note</strong>:<br>
        * The validity of this statistic depends on the assumption that the 
        * observations included in the model are drawn from a
  -     * <a href="http://mathworld.wolfram.com/
  -     * BivariateNormalDistribution.html">Bivariate Normal Distribution</a>.
  +     * <a href="http://mathworld.wolfram.com/BivariateNormalDistribution.html">
  +     * Bivariate Normal Distribution</a>.
        * <p>
        * If there are fewer that <strong>three</strong> observations in the 
        * model, or if there is no variation in x, this returns 
  
  
  
  1.6       +5 -4      jakarta-commons/math/src/java/org/apache/commons/math/stat/DescriptiveStatistics.java
  
  Index: DescriptiveStatistics.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/DescriptiveStatistics.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- DescriptiveStatistics.java	21 Feb 2004 21:35:15 -0000	1.5
  +++ DescriptiveStatistics.java	11 Apr 2004 19:00:45 -0000	1.6
  @@ -228,9 +228,10 @@
   
       /**
        * Returns an estimate for the pth percentile of the stored values. 
  -     * This estimate follows the interpolation-adjusted defintion presented 
  -     * <a href="http://www.utdallas.edu/~ammann/stat5311/node8.html">here</a>
  -     * <p/>
  +     * <p>
  +     * The implementation provided here follows the first estimation procedure presented
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a>
  +     * <p>
        * <strong>Preconditions</strong>:<ul>
        * <li><code>0 &lt; p &lt; 100</code> (otherwise an 
        * <code>IllegalArgumentException</code> is thrown)</li>
  
  
  
  1.26      +36 -38    jakarta-commons/math/src/java/org/apache/commons/math/stat/StatUtils.java
  
  Index: StatUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/StatUtils.java,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- StatUtils.java	4 Mar 2004 04:25:09 -0000	1.25
  +++ StatUtils.java	11 Apr 2004 19:00:45 -0000	1.26
  @@ -27,9 +27,9 @@
   import org.apache.commons.math.stat.univariate.summary.SumOfSquares;
   
   /**
  - * StatUtils provides easy static implementations of common double[] based
  + * StatUtils provides static implementations of common double[] based
    * statistical methods. These return a single result value or in some cases, as
  - * identified in the javadoc for each method, Double.NaN.
  + * identified in the javadoc for each method, <code>Double.NaN.</code>
    * @version $Revision$ $Date$
    */
   public final class StatUtils {
  @@ -70,7 +70,7 @@
       /**
        * The sum of the values that have been added to Univariate.
        * @param values Is a double[] containing the values
  -     * @return the sum of the values or Double.NaN if the array is empty
  +     * @return the sum of the values or <code>Double.NaN</code> if the array
is empty
        */
       public static double sum(final double[] values) {
           return sum.evaluate(values);
  @@ -81,7 +81,7 @@
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the sum of the values or Double.NaN if the array is empty
  +     * @return the sum of the values or <code>Double.NaN</code> if the array
is empty
        */
       public static double sum(
           final double[] values,
  @@ -93,7 +93,7 @@
       /**
        * Returns the sum of the squares of the available values.
        * @param values Is a double[] containing the values
  -     * @return the sum of the squared values or Double.NaN if the array is empty
  +     * @return the sum of the squared values or <code>Double.NaN</code> if
the array is empty
        */
       public static double sumSq(final double[] values) {
           return sumSq.evaluate(values);
  @@ -104,7 +104,7 @@
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the sum of the squared values or Double.NaN if the array is empty
  +     * @return the sum of the squared values or <code>Double.NaN</code> if
the array is empty
        */
       public static double sumSq(
           final double[] values,
  @@ -116,7 +116,7 @@
       /**
        * Returns the product for this collection of values
        * @param values Is a double[] containing the values
  -     * @return the product values or Double.NaN if the array is empty
  +     * @return the product values or <code>Double.NaN</code> if the array is
empty
        */
       public static double product(final double[] values) {
           return prod.evaluate(values);
  @@ -127,7 +127,7 @@
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the product values or Double.NaN if the array is empty
  +     * @return the product values or <code>Double.NaN</code> if the array is
empty
        */
       public static double product(
           final double[] values,
  @@ -139,7 +139,7 @@
       /**
        * Returns the sum of the natural logs for this collection of values
        * @param values Is a double[] containing the values
  -     * @return the sumLog value or Double.NaN if the array is empty
  +     * @return the sumLog value or <code>Double.NaN</code> if the array is
empty
        */
       public static double sumLog(final double[] values) {
           return sumLog.evaluate(values);
  @@ -150,7 +150,7 @@
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the sumLog value or Double.NaN if the array is empty
  +     * @return the sumLog value or <code>Double.NaN</code> if the array is
empty
        */
       public static double sumLog(
           final double[] values,
  @@ -160,22 +160,22 @@
       }
   
       /**
  -     * Returns the <a href=http://www.xycoon.com/arithmetic_mean.htm>
  +     * Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm">
        * arithmetic mean </a> of the available values
        * @param values Is a double[] containing the values
  -     * @return the mean of the values or Double.NaN if the array is empty
  +     * @return the mean of the values or <code>Double.NaN</code> if the array
is empty
        */
       public static double mean(final double[] values) {
           return mean.evaluate(values);
       }
   
       /**
  -      * Returns the <a href=http://www.xycoon.com/arithmetic_mean.htm>
  +      * Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm">
         * arithmetic mean </a> of the available values
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -      * @return the mean of the values or Double.NaN if the array is empty
  +      * @return the mean of the values or <code>Double.NaN</code> if the array
is empty
         */
       public static double mean(
           final double[] values,
  @@ -186,15 +186,14 @@
   
       /**
        * Returns the variance of the available values. This uses a corrected
  -     * two pass algorithm of the following
  -     * <a href="http://lib-www.lanl.gov/numerical/bookcpdf/c14-1.pdf">
  -     * corrected two pass formula (14.1.8)</a>, and also referenced in:<p/>
  +     * two pass algorithm as described in:
  +     * <p>
        * "Algorithms for Computing the Sample Variance: Analysis and
        * Recommendations", Chan, T.F., Golub, G.H., and LeVeque, R.J.
  -     * 1983, American Statistician, vol. 37, pp. 242?247.
  +     * 1983, American Statistician, vol. 37, pp. 242-247.
        *
        * @param values Is a double[] containing the values
  -     * @return the result, Double.NaN if no values for an empty array
  +     * @return the result, <code>Double.NaN</code> for an empty array
        * or 0.0 for a single value set.
        */
       public static double variance(final double[] values) {
  @@ -203,17 +202,16 @@
   
       /**
        * Returns the variance of the available values. This uses a corrected
  -     * two pass algorithm of the following
  -     * <a href="http://lib-www.lanl.gov/numerical/bookcpdf/c14-1.pdf">
  -     * corrected two pass formula (14.1.8)</a>, and also referenced in:<p/>
  +     * two pass algorithm as described in:
  +     * <p>
        * "Algorithms for Computing the Sample Variance: Analysis and
        * Recommendations", Chan, T.F., Golub, G.H., and LeVeque, R.J.
  -     * 1983, American Statistician, vol. 37, pp. 242?247.
  +     * 1983, American Statistician, vol. 37, pp. 242-247.
        *
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the result, Double.NaN if no values for an empty array
  +     * @return the result, <code>Double.NaN</code> for an empty array
        * or 0.0 for a single value set.
        */
       public static double variance(
  @@ -226,7 +224,7 @@
       /**
        * Returns the maximum of the available values
        * @param values Is a double[] containing the values
  -     * @return the maximum of the values or Double.NaN if the array is empty
  +     * @return the maximum of the values or <code>Double.NaN</code> if the
array is empty
        */
       public static double max(final double[] values) {
           return max.evaluate(values);
  @@ -237,7 +235,7 @@
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the maximum of the values or Double.NaN if the array is empty
  +     * @return the maximum of the values or <code>Double.NaN</code> if the
array is empty
        */
       public static double max(
           final double[] values,
  @@ -249,7 +247,7 @@
       /**
        * Returns the minimum of the available values
        * @param values Is a double[] containing the values
  -     * @return the minimum of the values or Double.NaN if the array is empty
  +     * @return the minimum of the values or <code>Double.NaN</code> if the
array is empty
        */
       public static double min(final double[] values) {
           return min.evaluate(values);
  @@ -260,7 +258,7 @@
        * @param values Is a double[] containing the values
        * @param begin processing at this point in the array
        * @param length the number of elements to include
  -     * @return the minimum of the values or Double.NaN if the array is empty
  +     * @return the minimum of the values or <code>Double.NaN</code> if the
array is empty
        */
       public static double min(
           final double[] values,
  @@ -271,9 +269,10 @@
       
       /**
        * Returns an estimate for the pth percentile of the stored values. 
  -     * This estimate follows the interpolation-adjusted defintion presented 
  -     * <a href="http://www.utdallas.edu/~ammann/stat5311/node8.html">here</a>
  -     * <p/>
  +     * <p>
  +     * The implementation provided here follows the first estimation procedure presented
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a>
  +     * <p>
        * <strong>Preconditions</strong>:<ul>
        * <li><code>0 &lt; p &lt; 100</code> (otherwise an 
        * <code>IllegalArgumentException</code> is thrown)</li>
  @@ -291,9 +290,10 @@
   
       /**
        * Returns an estimate for the pth percentile of the stored values. 
  -     * This estimate follows the interpolation-adjusted defintion presented 
  -     * <a href="http://www.utdallas.edu/~ammann/stat5311/node8.html">here</a>
  -     * <p/>
  +     *<p>
  +    * The implementation provided here follows the first estimation procedure presented
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a>
  +     * <p>
        * <strong>Preconditions</strong>:<ul>
        * <li><code>0 &lt; p &lt; 100</code> (otherwise an 
        * <code>IllegalArgumentException</code> is thrown)</li>
  @@ -313,7 +313,5 @@
               final int length, 
               final double p) {
               return percentile.evaluate(values, begin, length, p);
  -    }
  -    
  -
  +    }    
   }
  
  
  
  1.15      +72 -81    jakarta-commons/math/src/java/org/apache/commons/math/stat/TestStatistic.java
  
  Index: TestStatistic.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/TestStatistic.java,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- TestStatistic.java	8 Apr 2004 20:46:00 -0000	1.14
  +++ TestStatistic.java	11 Apr 2004 19:00:45 -0000	1.15
  @@ -25,9 +25,9 @@
   public interface TestStatistic {
       
       /**
  -     * Computes the <a href="http://www.itl.nist.gov/div898/handbook/eda
  -     * /section3/eda35f.htm">Chi-Square statistic</a> comparing 
  -     * <code>observed</code> and <code>expected</code> freqeuncy
counts. 
  +     * Computes the <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda35f.htm">
  +     * Chi-Square statistic</a> comparing <code>observed</code> and <code>expected</code>

  +     * freqeuncy counts. 
        * <p>
        * This statistic can be used to perform Chi-Square tests.
        * <p>
  @@ -53,14 +53,14 @@
       /**
        * Returns the <i>observed significance level</i>, or <a href=
        * "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
  -     * p-value</a>, associated with a <a href="http://www.itl.nist.gov/div898/
  -     * handbook/eda/section3/eda35f.htm">Chi-square goodness of fit test</a>
  -     * comparing the <code>observed</code> frequency counts to those in the

  -     * <code>expected</code> array.
  -     * <p>
  -     * The number returned is the smallest significance level
  -     * at which one can reject the null hypothesis that the observed counts
  -     * conform to the frequency distribution described by the expected counts. 
  +     * p-value</a>, associated with a 
  +     * <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda35f.htm">
  +     * Chi-square goodness of fit test</a> comparing the <code>observed</code>

  +     * frequency counts to those in the <code>expected</code> array.
  +     * <p>
  +     * The number returned is the smallest significance level at which one can reject 
  +     * the null hypothesis that the observed counts conform to the frequency distribution

  +     * described by the expected counts. 
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>Expected counts must all be positive.  
  @@ -83,11 +83,10 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/
  -     * section3/eda35f.htm">Chi-square goodness of fit test</a> evaluating the

  -     * null hypothesis that the observed counts conform to the frequency 
  -     * distribution described by the expected counts, with significance level 
  -     * <code>alpha</code>.
  +     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda35f.htm">
  +     * Chi-square goodness of fit test</a> evaluating the null hypothesis that the
observed counts 
  +     * conform to the frequency distribution described by the expected counts, with 
  +     * significance level <code>alpha</code>.
        * <p>
        * <strong>Example:</strong><br>
        * To test the hypothesis that <code>observed</code> follows 
  @@ -118,9 +117,8 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/
  -     * section2/prc22.htm#formula"> t statistic </a> given observed values and

  -     * a comparison constant.
  +     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc22.htm#formula">

  +     * t statistic </a> given observed values and a comparison constant.
        * <p>
        * This statistic can be used to perform a one sample t-test for the mean.
        * <p>
  @@ -137,9 +135,8 @@
           throws IllegalArgumentException;
       
       /**
  -     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/section3
  -     * /prc31.htm">2-sample t statistic </a>, without the assumption of equal
  -     * sample variances.
  +     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/section3/prc31.htm">
  +     * 2-sample t statistic </a>, without the assumption of equal sample variances.
        * <p>
        * This statistic can be used to perform a two-sample t-test to compare
        * sample means.
  @@ -159,8 +156,8 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Returns the <i>observed significance level</i>, or <a href=
  -     * "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
  +     * Returns the <i>observed significance level</i>, or 
  +     * <a href="http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
        * p-value</a>, associated with a two-sample, two-tailed t-test 
        * comparing the means of the input arrays.
        * <p>
  @@ -171,13 +168,13 @@
        * <p>
        * The test does not assume that the underlying popuation variances are
        * equal and it uses approximated degrees of freedom computed from the 
  -     * sample data as described <a href="http://www.itl.nist.gov/div898/
  -     * handbook/prc/section3/prc31.htm">here</a>
  +     * sample data as described 
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section3/prc31.htm">here</a>
        * <p>
        * <strong>Usage Note:</strong><br>
        * The validity of the p-value depends on the assumptions of the parametric
  -     * t-test procedure, as discussed <a href="http://www.basic.nwu.edu/
  -     * statguidefiles/ttest_unpaired_ass_viol.html">here</a>
  +     * t-test procedure, as discussed 
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/ttest_unpaired_ass_viol.html">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The observed array lengths must both be at least 5.
  @@ -193,11 +190,10 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/
  -     * section3/eda353.htm">two-sided t-test</a> evaluating the null 
  -     * hypothesis that <code>sample1</code> and <code>sample2</code>
are drawn 
  -     * from populations with the same mean, with significance level 
  -     * <code>alpha</code>.
  +     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda353.htm">
  +     * two-sided t-test</a> evaluating the null hypothesis that <code>sample1</code>

  +     * and <code>sample2</code> are drawn from populations with the same mean,

  +     * with significance level <code>alpha</code>.
        * <p>
        * Returns <code>true</code> iff the null hypothesis that the means are
        * equal can be rejected with confidence <code>1 - alpha</code>.  To 
  @@ -215,13 +211,13 @@
        * <p>
        * The test does not assume that the underlying popuation variances are
        * equal and it uses approximated degrees of freedom computed from the 
  -     * sample data as described <a href="http://www.itl.nist.gov/div898/
  -     * handbook/prc/section3/prc31.htm">here</a>
  +     * sample data as described 
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section3/prc31.htm">here</a>
        * <p>
        * <strong>Usage Note:</strong><br>
        * The validity of the test depends on the assumptions of the parametric
  -     * t-test procedure, as discussed <a href="http://www.basic.nwu.edu/
  -     * statguidefiles/ttest_unpaired_ass_viol.html">here</a>
  +     * t-test procedure, as discussed 
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/ttest_unpaired_ass_viol.html">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The observed array lengths must both be at least 5.
  @@ -241,10 +237,9 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/
  -     * section3/eda353.htm">two-sided t-test</a> evaluating the null 
  -     * hypothesis that the mean of the population from which 
  -     * <code>sample</code> is drawn equals <code>mu</code>.
  +     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda353.htm">
  +     * two-sided t-test</a> evaluating the null hypothesis that the mean of the population
from
  +     *  which <code>sample</code> is drawn equals <code>mu</code>.
        * <p>
        * Returns <code>true</code> iff the null hypothesis can be 
        * rejected with confidence <code>1 - alpha</code>.  To 
  @@ -263,8 +258,7 @@
        * <strong>Usage Note:</strong><br>
        * The validity of the test depends on the assumptions of the one-sample 
        * parametric t-test procedure, as discussed 
  -     * <a href="http://www.basic.nwu.edu/statguidefiles/
  -     * sg_glos.html#one-sample">here</a>
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/sg_glos.html#one-sample">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The observed array length must be at least 5.
  @@ -281,8 +275,8 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Returns the <i>observed significance level</i>, or <a href=
  -     * "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
  +     * Returns the <i>observed significance level</i>, or 
  +     * <a href="http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
        * p-value</a>, associated with a one-sample, two-tailed t-test 
        * comparing the mean of the input array with the constant <code>mu</code>.
        * <p>
  @@ -294,8 +288,8 @@
        * <p>
        * <strong>Usage Note:</strong><br>
        * The validity of the test depends on the assumptions of the parametric
  -     * t-test procedure, as discussed <a href="http://www.basic.nwu.edu/
  -     * statguidefiles/ttest_unpaired_ass_viol.html">here</a>
  +     * t-test procedure, as discussed 
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/ttest_unpaired_ass_viol.html">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The observed array length must be at least 5.
  @@ -311,9 +305,9 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/
  -     * section2/prc22.htm#formula"> t statistic </a> to use in comparing 
  -     * the dataset described by <code>sampleStats</code> to <code>mu</code>.
  +     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc22.htm#formula">
  +     * t statistic </a> to use in comparing the dataset described by <code>sampleStats</code>
  +     *  to <code>mu</code>.
        * <p>
        * This statistic can be used to perform a one sample t-test for the mean.
        * <p>
  @@ -330,9 +324,9 @@
           throws IllegalArgumentException;
       
       /**
  -     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/section3
  -     * /prc31.htm">2-sample t statistic </a>, comparing the datasets described
  -     * by two Univariates without the assumption of equal sample variances.
  +     * Computes a <a href="http://www.itl.nist.gov/div898/handbook/prc/section3/prc31.htm">
  +     * 2-sample t statistic </a>, comparing the means of the datasets described
  +     * by two {@link StatisticalSummary} instances without the assumption of equal sample
variances.
        * <p>
        * This statistic can be used to perform a two-sample t-test to compare
        * sample means.
  @@ -342,8 +336,8 @@
        * at least 5 observations.
        * </li></ul>
        *
  -     * @param sampleStats1 DescriptiveStatistics describing data from the first sample
  -     * @param sampleStats2 DescriptiveStatistics describing data from the second sample
  +     * @param sampleStats1 StatisticalSummary describing data from the first sample
  +     * @param sampleStats2 StatisticalSummary describing data from the second sample
        * @return t statistic
        * @throws IllegalArgumentException if the precondition is not met
        */
  @@ -351,8 +345,8 @@
           throws IllegalArgumentException;
       
       /**
  -     * Returns the <i>observed significance level</i>, or <a href=
  -     * "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
  +     * Returns the <i>observed significance level</i>, or 
  +     * <a href="http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
        * p-value</a>, associated with a two-sample, two-tailed t-test 
        * comparing the means of the datasets described by two Univariates.
        * <p>
  @@ -363,13 +357,13 @@
        * <p>
        * The test does not assume that the underlying popuation variances are
        * equal and it uses approximated degrees of freedom computed from the 
  -     * sample data as described <a href="http://www.itl.nist.gov/div898/
  -     * handbook/prc/section3/prc31.htm">here</a>
  +     * sample data as described 
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section3/prc31.htm">here</a>
        * <p>
        * <strong>Usage Note:</strong><br>
        * The validity of the p-value depends on the assumptions of the parametric
  -     * t-test procedure, as discussed <a href="http://www.basic.nwu.edu/
  -     * statguidefiles/ttest_unpaired_ass_viol.html">here</a>
  +     * t-test procedure, as discussed 
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/ttest_unpaired_ass_viol.html">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The datasets described by the two Univariates must each contain
  @@ -386,11 +380,10 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/
  -     * section3/eda353.htm">two-sided t-test</a> evaluating the null 
  -     * hypothesis that <code>sampleStats1</code> and <code>sampleStats2</code>

  -     * describe datasets drawn from populations with the same mean, with 
  -     * significance level <code>alpha</code>.
  +     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda353.htm">
  +     * two-sided t-test</a> evaluating the null hypothesis that <code>sampleStats1</code>
  +     * and <code>sampleStats2</code> describe datasets drawn from populations
with the 
  +     * same mean, with significance level <code>alpha</code>.
        * <p>
        * Returns <code>true</code> iff the null hypothesis that the means are
        * equal can be rejected with confidence <code>1 - alpha</code>.  To 
  @@ -409,13 +402,13 @@
        * <p>
        * The test does not assume that the underlying popuation variances are
        * equal and it uses approximated degrees of freedom computed from the 
  -     * sample data as described <a href="http://www.itl.nist.gov/div898/
  -     * handbook/prc/section3/prc31.htm">here</a>
  +     * sample data as described 
  +     * <a href="http://www.itl.nist.gov/div898/handbook/prc/section3/prc31.htm">here</a>
        * <p>
        * <strong>Usage Note:</strong><br>
        * The validity of the test depends on the assumptions of the parametric
  -     * t-test procedure, as discussed <a href="http://www.basic.nwu.edu/
  -     * statguidefiles/ttest_unpaired_ass_viol.html">here</a>
  +     * t-test procedure, as discussed 
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/ttest_unpaired_ass_viol.html">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The datasets described by the two Univariates must each contain
  @@ -437,10 +430,9 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/
  -     * section3/eda353.htm">two-sided t-test</a> evaluating the null 
  -     * hypothesis that the mean of the population from which the dataset  
  -     * described by <code>stats</code> is drawn equals <code>mu</code>.
  +     * Performs a <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda353.htm">
  +     * two-sided t-test</a> evaluating the null hypothesis that the mean of the population
from
  +     * which the dataset described by <code>stats</code> is drawn equals <code>mu</code>.
        * <p>
        * Returns <code>true</code> iff the null hypothesis can be 
        * rejected with confidence <code>1 - alpha</code>.  To 
  @@ -459,8 +451,7 @@
        * <strong>Usage Note:</strong><br>
        * The validity of the test depends on the assumptions of the one-sample 
        * parametric t-test procedure, as discussed 
  -     * <a href="http://www.basic.nwu.edu/statguidefiles/
  -     * sg_glos.html#one-sample">here</a>
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/sg_glos.html#one-sample">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The sample must include at least 5 observations.
  @@ -477,8 +468,8 @@
           throws IllegalArgumentException, MathException;
       
       /**
  -     * Returns the <i>observed significance level</i>, or <a href=
  -     * "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
  +     * Returns the <i>observed significance level</i>, or 
  +     * <a href="http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
        * p-value</a>, associated with a one-sample, two-tailed t-test 
        * comparing the mean of the dataset described by <code>sampleStats</code>
        * with the constant <code>mu</code>.
  @@ -491,8 +482,8 @@
        * <p>
        * <strong>Usage Note:</strong><br>
        * The validity of the test depends on the assumptions of the parametric
  -     * t-test procedure, as discussed <a href="http://www.basic.nwu.edu/
  -     * statguidefiles/ttest_unpaired_ass_viol.html">here</a>
  +     * t-test procedure, as discussed 
  +     * <a href="http://www.basic.nwu.edu/statguidefiles/ttest_unpaired_ass_viol.html">here</a>
        * <p>
        * <strong>Preconditions</strong>: <ul>
        * <li>The sample must contain at least 5 observations.
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message