Mailing-List: contact commits-help@harmony.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@harmony.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r547202 -
 /harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Random.java
Date: Thu, 14 Jun 2007 10:23:07 -0000
To: commits@harmony.apache.org
From: odeakin@apache.org
Message-Id: <20070614102307.84CBC1A981A@eris.apache.org>

Author: odeakin
Date: Thu Jun 14 03:23:02 2007
New Revision: 547202

URL: http://svn.apache.org/viewvc?view=rev&rev=547202
Log:
Apply patch HARMONY-4160 ([classlib] [luni] Updated Javadoc for java.util.Random)

Modified:
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Random.java

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Random.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Random.java?view=diff&rev=547202&r1=547201&r2=547202
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Random.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/util/Random.java Thu Jun 14 03:23:02 2007
@@ -77,12 +77,14 @@
     }
 
     /**
-     * Answers a pseudo-random uniformly distributed <code>int</code> value of
-     * the number of bits specified by the argument <code>bits</code> as
-     * described by Donald E. Knuth in <i>The Art of Computer Programming,
-     * Volume 2: Seminumerical Algorithms</i>, section 3.2.1.
+     * Returns a pseudo-random uniformly distributed <code>int</code> value of
+     * the number of bits specified by the argument <code>bits</code>.
      * 
-     * @return int a pseudo-random generated int number
+     * Implements D. H. Lehmer's random number algorithm found in <i>The Art of
+     * Computer Programming, Volume 2: Seminumerical Algorithms</i>, by Donald
+     * E. Knuth (section 3.2.1).
+     * 
+     * @return a pseudo-randomly generated int
      * @param bits
      *            number of bits of the returned value
      * 
@@ -136,7 +138,7 @@
      * Generates a normally distributed random double number between 0.0
      * inclusively and 1.0 exclusively.
      * 
-     * @return double
+     * @return a random double between 0.0 and 1.0
      * 
      * @see #nextFloat
      */
@@ -148,7 +150,7 @@
      * Generates a normally distributed random float number between 0.0
      * inclusively and 1.0 exclusively.
      * 
-     * @return float a random float number between 0.0 and 1.0
+     * @return a random float between 0.0 and 1.0
      * 
      * @see #nextDouble
      */
@@ -157,14 +159,15 @@
     }
 
     /**
-     * pseudo-randomly generates (approximately) a normally distributed
+     * Returns a pseudo-randomly generated, normally distributed
      * <code>double</code> value with mean 0.0 and a standard deviation value
-     * of <code>1.0</code> using the <i>polar method<i> of G. E. P. Box, M.
-     * E. Muller, and G. Marsaglia, as described by Donald E. Knuth in <i>The
-     * Art of Computer Programming, Volume 2: Seminumerical Algorithms</i>,
-     * section 3.4.1, subsection C, algorithm P
+     * of <code>1.0</code>.
+     * 
+     * Implements G. E. P. Box, M. E. Muller, and G. Marsaglia's polar method
+     * found in <i>The Art of Computer Programming, Volume 2: Seminumerical
+     * Algorithms</i>, by Donald E. Knuth (section 3.4.1).
      * 
-     * @return double
+     * @return a pseudo-randomly generated double
      * 
      * @see #nextDouble
      */
@@ -194,7 +197,7 @@
      * Generates a uniformly distributed 32-bit <code>int</code> value from
      * the this random number sequence.
      * 
-     * @return int uniformly distributed <code>int</code> value
+     * @return a randomly generated <code>int</code>
      * 
      * @see java.lang.Integer#MAX_VALUE
      * @see java.lang.Integer#MIN_VALUE
@@ -206,13 +209,12 @@
     }
 
     /**
-     * Returns to the caller a new pseudo-random integer value which is uniformly
-     * distributed between 0 (inclusively) and the value of <code>n</code>
-     * (exclusively).
+     * Returns a new pseudo-random integer value which is uniformly distributed
+     * between 0 (inclusively) and <code>n</code> (exclusively).
      * 
-     * @return int
+     * @return a randomly generated <code>int</code> between 0 and n
      * @param n
-     *            int
+     *            the upper limit of the values that can be returned
      */
     public int nextInt(int n) {
         if (n > 0) {
@@ -246,8 +248,9 @@
     }
 
     /**
-     * Modifies the seed using linear congruential formula presented in <i>The
-     * Art of Computer Programming, Volume 2</i>, Section 3.2.1.
+     * Modifies the seed using a linear congruential formula, as found in <i>The
+     * Art of Computer Programming, Volume 2</i>, by Donald E. Knuth (section
+     * 3.2.1).
      * 
      * @param seed
      *            the seed that alters the state of the random number generator