commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brentwor...@apache.org
Subject cvs commit: jakarta-commons/math/src/java/org/apache/commons/math/special Beta.java Gamma.java
Date Fri, 23 Apr 2004 19:30:47 GMT
brentworden    2004/04/23 12:30:47

  Modified:    math/src/java/org/apache/commons/math/special Beta.java
                        Gamma.java
  Log:
  Added some parameter javadoc comments.
  
  Revision  Changes    Path
  1.18      +23 -19    jakarta-commons/math/src/java/org/apache/commons/math/special/Beta.java
  
  Index: Beta.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/special/Beta.java,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- Beta.java	18 Feb 2004 03:24:20 -0000	1.17
  +++ Beta.java	23 Apr 2004 19:30:47 -0000	1.18
  @@ -40,11 +40,13 @@
       }
   
       /**
  -     * Returns the regularized beta function I(x, a, b).
  +     * Returns the
  +     * <a href="http://mathworld.wolfram.com/RegularizedBetaFunction.html">
  +     * regularized beta function</a> I(x, a, b).
        * 
  -     * @param x ???
  -     * @param a ???
  -     * @param b ???
  +     * @param x the value.
  +     * @param a the a parameter.
  +     * @param b the b parameter.
        * @return the regularized beta function I(x, a, b)
        * @throws MathException if the algorithm fails to converge.
        */
  @@ -55,11 +57,13 @@
       }
   
       /**
  -     * Returns the regularized beta function I(x, a, b).
  +     * Returns the
  +     * <a href="http://mathworld.wolfram.com/RegularizedBetaFunction.html">
  +     * regularized beta function</a> I(x, a, b).
        * 
  -     * @param x ???
  -     * @param a ???
  -     * @param b ???
  +     * @param x the value.
  +     * @param a the a parameter.
  +     * @param b the b parameter.
        * @param epsilon When the absolute value of the nth item in the
        *                series is less than epsilon the approximation ceases
        *                to calculate further elements in the series.
  @@ -75,9 +79,9 @@
       /**
        * Returns the regularized beta function I(x, a, b).
        * 
  -     * @param x ???
  -     * @param a ???
  -     * @param b ???
  +     * @param x the value.
  +     * @param a the a parameter.
  +     * @param b the b parameter.
        * @param maxIterations Maximum number of "iterations" to complete. 
        * @return the regularized beta function I(x, a, b)
        * @throws MathException if the algorithm fails to converge.
  @@ -101,9 +105,9 @@
        * Regularized Beta Function</a>.</li>
        * </ul>
        * 
  -     * @param x ???
  -     * @param a ???
  -     * @param b ???
  +     * @param x the value.
  +     * @param a the a parameter.
  +     * @param b the b parameter.
        * @param epsilon When the absolute value of the nth item in the
        *                series is less than epsilon the approximation ceases
        *                to calculate further elements in the series.
  @@ -170,8 +174,8 @@
       /**
        * Returns the natural logarithm of the beta function B(a, b).
        * 
  -     * @param a ???
  -     * @param b ???
  +     * @param a the a parameter.
  +     * @param b the b parameter.
        * @return log(B(a, b))
        */
       public static double logBeta(double a, double b) {
  @@ -187,8 +191,8 @@
        * Beta Function</a>, equation (1).</li>
        * </ul>
        * 
  -     * @param a ???
  -     * @param b ???
  +     * @param a the a parameter.
  +     * @param b the b parameter.
        * @param epsilon When the absolute value of the nth item in the
        *                series is less than epsilon the approximation ceases
        *                to calculate further elements in the series.
  
  
  
  1.18      +6 -7      jakarta-commons/math/src/java/org/apache/commons/math/special/Gamma.java
  
  Index: Gamma.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/special/Gamma.java,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- Gamma.java	21 Feb 2004 21:35:15 -0000	1.17
  +++ Gamma.java	23 Apr 2004 19:30:47 -0000	1.18
  @@ -61,8 +61,8 @@
       /**
        * Returns the regularized gamma function P(a, x).
        * 
  -     * @param a ???
  -     * @param x ???
  +     * @param a the a parameter.
  +     * @param x the value.
        * @return the regularized gamma function P(a, x)
        * @throws MathException if the algorithm fails to converge.
        */
  @@ -89,8 +89,8 @@
        * </li>
        * </ul>
        * 
  -     * @param a ???
  -     * @param x ???
  +     * @param a the a parameter.
  +     * @param x the value.
        * @param epsilon When the absolute value of the nth item in the
        *                series is less than epsilon the approximation ceases
        *                to calculate further elements in the series.
  @@ -148,7 +148,7 @@
        * </a></li>
        * </ul>
        * 
  -     * @param x ???
  +     * @param x the value.
        * @return log(&#915;(x))
        */
       public static double logGamma(double x) {
  @@ -173,4 +173,3 @@
           return ret;
       }
   }
  -
  
  
  

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