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/univariate/rank Max.java Min.java Percentile.java
Date Sun, 11 Jul 2004 18:39:08 GMT
psteitz     2004/07/11 11:39:08

  Modified:    math/src/java/org/apache/commons/math/stat/univariate/rank
                        Max.java Min.java Percentile.java
  Log:
  javadoc only.
  
  Revision  Changes    Path
  1.21      +2 -2      jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Max.java
  
  Index: Max.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Max.java,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- Max.java	10 Jul 2004 17:09:08 -0000	1.20
  +++ Max.java	11 Jul 2004 18:39:08 -0000	1.21
  @@ -97,7 +97,7 @@
        * @param values the input array
        * @param begin index of the first array element to include
        * @param length the number of elements to include
  -     * @return the mean of the values or Double.NaN if length = 0
  +     * @return the maximum of the values or Double.NaN if length = 0
        * @throws IllegalArgumentException if the array is null or the array index
        *  parameters are not valid
        */
  
  
  
  1.22      +2 -2      jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Min.java
  
  Index: Min.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Min.java,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- Min.java	10 Jul 2004 17:09:08 -0000	1.21
  +++ Min.java	11 Jul 2004 18:39:08 -0000	1.22
  @@ -97,7 +97,7 @@
        * @param values the input array
        * @param begin index of the first array element to include
        * @param length the number of elements to include
  -     * @return the mean of the values or Double.NaN if length = 0
  +     * @return the minimum of the values or Double.NaN if length = 0
        * @throws IllegalArgumentException if the array is null or the array index
        *  parameters are not valid
        */
  
  
  
  1.23      +8 -5      jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Percentile.java
  
  Index: Percentile.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/rank/Percentile.java,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- Percentile.java	4 Jul 2004 09:02:36 -0000	1.22
  +++ Percentile.java	11 Jul 2004 18:39:08 -0000	1.23
  @@ -102,7 +102,8 @@
        * <li>Returns (for any value of <code>p</code>) <code>values[0]</code>
        *  if <code>values</code> has length <code>1</code></li>
        * <li>Throws <code>IllegalArgumentException</code> if <code>values</code>
  -     *  is null </li>
  +     * is null or p is not a valid quantile value (p must be greater than 0
  +     * and less than or equal to 100) </li>
        * </ul>
        * <p>
        * See {@link Percentile} for a description of the percentile estimation
  @@ -110,8 +111,9 @@
        * 
        * @param values input array of values
        * @param p the percentile value to compute
  -     * @return the result of the evaluation or Double.NaN if the array is empty
  -     * @throws IllegalArgumentException if <code>values</code> is null
  +     * @return the percentile value or Double.NaN if the array is empty
  +     * @throws IllegalArgumentException if <code>values</code> is null 
  +     *     or p is invalid
        */
       public double evaluate(final double[] values, final double p) {
           test(values, 0, 0);
  @@ -161,7 +163,8 @@
        *  if <code>length = 1 </code></li>
        * <li>Throws <code>IllegalArgumentException</code> if <code>values</code>
        *  is null , <code>begin</code> or <code>length</code> is
invalid, or 
  -     * <code>p</code> is not a valid quantile value</li>
  +     * <code>p</code> is not a valid quantile value (p must be greater than
0
  +     * and less than or equal to 100)</li>
        * </ul>
        * <p>
         * See {@link Percentile} for a description of the percentile estimation
  
  
  

---------------------------------------------------------------------
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