You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by md...@apache.org on 2003/06/16 23:29:49 UTC

cvs commit: jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat StoreUnivariate.java

mdiggory    2003/06/16 14:29:49

  Modified:    math/src/java/org/apache/commons/math/stat
                        StoreUnivariate.java
  Log:
  More correction of Javadoc errors.
  
  Revision  Changes    Path
  1.3       +6 -6      jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/StoreUnivariate.java
  
  Index: StoreUnivariate.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/math/src/java/org/apache/commons/math/stat/StoreUnivariate.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- StoreUnivariate.java	4 Jun 2003 02:22:48 -0000	1.2
  +++ StoreUnivariate.java	16 Jun 2003 21:29:49 -0000	1.3
  @@ -140,19 +140,19 @@
       public abstract double getElement(int index);
       
       /**
  -     * Returns an estimate for the pth percentile of the stored values,
  -     * following the interpolation-adjusted defintion presented 
  -     * <a href="http://www.utdallas.edu/~ammann/stat5311/node8.html">here</a><p>
  -     *
  +     * 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/>
        * <strong>Preconditions</strong>:<ul>
  -     * <li><code>0 < p < 100</code> (otherwise an <code>IllegalArgumentException
  +     * <li><code>0 &lt; p &lt; 100</code> (otherwise an <code>IllegalArgumentException
        *     </code> is thrown)</li>
        * <li>at least one value must be stored (returns <code>Double.NaN
        *     </code> otherwise)</li>
        * </ul>
        * 
        * @param p the requested percentile (scaled from 0 - 100)
  -     * @return returns an estimate for the pth percentile of the stored data 
  +     * @return An estimate for the pth percentile of the stored data 
        * values
        */
       public abstract double getPercentile(double p);
  
  
  

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