ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/SplittableRandom.java
(Generate patch)

Comparing jsr166/src/main/java/util/SplittableRandom.java (file contents):
Revision 1.17 by jsr166, Tue Aug 13 23:34:47 2013 UTC vs.
Revision 1.26 by jsr166, Wed Dec 31 07:54:13 2014 UTC

# Line 25 | Line 25
25  
26   package java.util;
27  
28 import java.net.InetAddress;
28   import java.util.concurrent.atomic.AtomicLong;
29 < import java.util.Spliterator;
29 > import java.util.function.DoubleConsumer;
30   import java.util.function.IntConsumer;
31   import java.util.function.LongConsumer;
32 < import java.util.function.DoubleConsumer;
34 < import java.util.stream.StreamSupport;
32 > import java.util.stream.DoubleStream;
33   import java.util.stream.IntStream;
34   import java.util.stream.LongStream;
35 < import java.util.stream.DoubleStream;
35 > import java.util.stream.StreamSupport;
36  
37   /**
38   * A generator of uniform pseudorandom values applicable for use in
39   * (among other contexts) isolated parallel computations that may
40 < * generate subtasks. Class SplittableRandom supports methods for
40 > * generate subtasks. Class {@code SplittableRandom} supports methods for
41   * producing pseudorandom numbers of type {@code int}, {@code long},
42   * and {@code double} with similar usages as for class
43   * {@link java.util.Random} but differs in the following ways:
# Line 77 | Line 75 | import java.util.stream.DoubleStream;
75   *
76   * </ul>
77   *
78 + * <p>Instances of {@code SplittableRandom} are not cryptographically
79 + * secure.  Consider instead using {@link java.security.SecureRandom}
80 + * in security-sensitive applications. Additionally,
81 + * default-constructed instances do not use a cryptographically random
82 + * seed unless the {@linkplain System#getProperty system property}
83 + * {@code java.util.secureRandomSeed} is set to {@code true}.
84 + *
85   * @author  Guy Steele
86   * @author  Doug Lea
87   * @since   1.8
88   */
89 < public class SplittableRandom {
89 > public final class SplittableRandom {
90  
91      /*
92       * Implementation Overview.
# Line 101 | Line 106 | public class SplittableRandom {
106       * Methods nextLong, nextInt, and derivatives do not return the
107       * sequence (seed) values, but instead a hash-like bit-mix of
108       * their bits, producing more independently distributed sequences.
109 <     * For nextLong, the mix64 bit-mixing function computes the same
110 <     * value as the "64-bit finalizer" function in Austin Appleby's
111 <     * MurmurHash3 algorithm.  See
112 <     * http://code.google.com/p/smhasher/wiki/MurmurHash3 , which
113 <     * comments: "The constants for the finalizers were generated by a
114 <     * simple simulated-annealing algorithm, and both avalanche all
115 <     * bits of 'h' to within 0.25% bias." The mix32 function is
111 <     * equivalent to (int)(mix64(seed) >>> 32), but faster because it
112 <     * omits a step that doesn't contribute to result.
109 >     * For nextLong, the mix64 function is based on David Stafford's
110 >     * (http://zimbry.blogspot.com/2011/09/better-bit-mixing-improving-on.html)
111 >     * "Mix13" variant of the "64-bit finalizer" function in Austin
112 >     * Appleby's MurmurHash3 algorithm (see
113 >     * http://code.google.com/p/smhasher/wiki/MurmurHash3). The mix32
114 >     * function is based on Stafford's Mix04 mix function, but returns
115 >     * the upper 32 bits cast as int.
116       *
117       * The split operation uses the current generator to form the seed
118       * and gamma for another SplittableRandom.  To conservatively
119       * avoid potential correlations between seed and value generation,
120 <     * gamma selection (method nextGamma) uses the "Mix13" constants
121 <     * for MurmurHash3 described by David Stafford
122 <     * (http://zimbry.blogspot.com/2011/09/better-bit-mixing-improving-on.html)
123 <     * To avoid potential weaknesses in bit-mixing transformations, we
124 <     * restrict gammas to odd values with at least 12 and no more than
125 <     * 52 bits set.  Rather than rejecting candidates with too few or
126 <     * too many bits set, method nextGamma flips some bits (which has
127 <     * the effect of mapping at most 4 to any given gamma value).
125 <     * This reduces the effective set of 64bit odd gamma values by
126 <     * about 2<sup>14</sup>, a very tiny percentage, and serves as an
120 >     * gamma selection (method mixGamma) uses different
121 >     * (Murmurhash3's) mix constants.  To avoid potential weaknesses
122 >     * in bit-mixing transformations, we restrict gammas to odd values
123 >     * with at least 24 0-1 or 1-0 bit transitions.  Rather than
124 >     * rejecting candidates with too few or too many bits set, method
125 >     * mixGamma flips some bits (which has the effect of mapping at
126 >     * most 4 to any given gamma value).  This reduces the effective
127 >     * set of 64bit odd gamma values by about 2%, and serves as an
128       * automated screening for sequence constant selection that is
129       * left as an empirical decision in some other hashing and crypto
130       * algorithms.
# Line 134 | Line 135 | public class SplittableRandom {
135       * avalanching.
136       *
137       * The default (no-argument) constructor, in essence, invokes
138 <     * split() for a common "seeder" SplittableRandom.  Unlike other
139 <     * cases, this split must be performed in a thread-safe manner, so
140 <     * we use an AtomicLong to represent the seed rather than use an
141 <     * explicit SplittableRandom. To bootstrap the seeder, we start
142 <     * off using a seed based on current time and host. This serves as
143 <     * a slimmed-down (and insecure) variant of SecureRandom that also
144 <     * avoids stalls that may occur when using /dev/random.
138 >     * split() for a common "defaultGen" SplittableRandom.  Unlike
139 >     * other cases, this split must be performed in a thread-safe
140 >     * manner, so we use an AtomicLong to represent the seed rather
141 >     * than use an explicit SplittableRandom. To bootstrap the
142 >     * defaultGen, we start off using a seed based on current time
143 >     * unless the java.util.secureRandomSeed property is set. This
144 >     * serves as a slimmed-down (and insecure) variant of SecureRandom
145 >     * that also avoids stalls that may occur when using /dev/random.
146       *
147       * It is a relatively simple matter to apply the basic design here
148       * to use 128 bit seeds. However, emulating 128bit arithmetic and
# Line 153 | Line 155 | public class SplittableRandom {
155       */
156  
157      /**
158 <     * The initial gamma value for (unsplit) SplittableRandoms. Must
159 <     * be odd with at least 12 and no more than 52 bits set. Currently
158 <     * set to the golden ratio scaled to 64bits.
158 >     * The golden ratio scaled to 64bits, used as the initial gamma
159 >     * value for (unsplit) SplittableRandoms.
160       */
161 <    private static final long INITIAL_GAMMA = 0x9e3779b97f4a7c15L;
161 >    private static final long GOLDEN_GAMMA = 0x9e3779b97f4a7c15L;
162  
163      /**
164       * The least non-zero value returned by nextDouble(). This value
165       * is scaled by a random value of 53 bits to produce a result.
166       */
167 <    private static final double DOUBLE_UNIT = 1.0 / (1L << 53);
167 >    private static final double DOUBLE_UNIT = 0x1.0p-53; // 1.0 / (1L << 53);
168  
169      /**
170       * The seed. Updated only via method nextSeed.
# Line 184 | Line 185 | public class SplittableRandom {
185      }
186  
187      /**
188 <     * Computes MurmurHash3 64bit mix function.
188 >     * Computes Stafford variant 13 of 64bit mix function.
189       */
190      private static long mix64(long z) {
191 <        z = (z ^ (z >>> 33)) * 0xff51afd7ed558ccdL;
192 <        z = (z ^ (z >>> 33)) * 0xc4ceb9fe1a85ec53L;
193 <        return z ^ (z >>> 33);
191 >        z = (z ^ (z >>> 30)) * 0xbf58476d1ce4e5b9L;
192 >        z = (z ^ (z >>> 27)) * 0x94d049bb133111ebL;
193 >        return z ^ (z >>> 31);
194      }
195  
196      /**
197 <     * Returns the 32 high bits of mix64(z) as int.
197 >     * Returns the 32 high bits of Stafford variant 4 mix64 function as int.
198       */
199      private static int mix32(long z) {
200 <        z = (z ^ (z >>> 33)) * 0xff51afd7ed558ccdL;
201 <        return (int)(((z ^ (z >>> 33)) * 0xc4ceb9fe1a85ec53L) >>> 32);
200 >        z = (z ^ (z >>> 33)) * 0x62a9d9ed799705f5L;
201 >        return (int)(((z ^ (z >>> 28)) * 0xcb24d0a5c88c35b3L) >>> 32);
202      }
203  
204      /**
205       * Returns the gamma value to use for a new split instance.
206       */
207 <    private static long nextGamma(long z) {
208 <        z = (z ^ (z >>> 30)) * 0xbf58476d1ce4e5b9L; // Stafford "Mix13"
209 <        z = (z ^ (z >>> 27)) * 0x94d049bb133111ebL;
210 <        z = (z ^ (z >>> 31)) | 1L; // force to be odd
211 <        int n = Long.bitCount(z);  // ensure enough 0 and 1 bits
212 <        return (n < 12 || n > 52) ? z ^ 0xaaaaaaaaaaaaaaaaL : z;
207 >    private static long mixGamma(long z) {
208 >        z = (z ^ (z >>> 33)) * 0xff51afd7ed558ccdL; // MurmurHash3 mix constants
209 >        z = (z ^ (z >>> 33)) * 0xc4ceb9fe1a85ec53L;
210 >        z = (z ^ (z >>> 33)) | 1L;                  // force to be odd
211 >        int n = Long.bitCount(z ^ (z >>> 1));       // ensure enough transitions
212 >        return (n < 24) ? z ^ 0xaaaaaaaaaaaaaaaaL : z;
213      }
214  
215      /**
# Line 221 | Line 222 | public class SplittableRandom {
222      /**
223       * The seed generator for default constructors.
224       */
225 <    private static final AtomicLong seeder =
225 <        new AtomicLong(mix64((((long)hashedHostAddress()) << 32) ^
226 <                             System.currentTimeMillis()) ^
227 <                       mix64(System.nanoTime()));
225 >    private static final AtomicLong defaultGen = new AtomicLong(initialSeed());
226  
227 <    /**
228 <     * Returns hash of local host IP address, if available; else 0.
229 <     */
230 <    private static int hashedHostAddress() {
231 <        try {
232 <            return InetAddress.getLocalHost().hashCode();
233 <        } catch (Exception ex) {
234 <            return 0;
227 >    private static long initialSeed() {
228 >        String pp = java.security.AccessController.doPrivileged(
229 >                new sun.security.action.GetPropertyAction(
230 >                        "java.util.secureRandomSeed"));
231 >        if (pp != null && pp.equalsIgnoreCase("true")) {
232 >            byte[] seedBytes = java.security.SecureRandom.getSeed(8);
233 >            long s = (long)(seedBytes[0]) & 0xffL;
234 >            for (int i = 1; i < 8; ++i)
235 >                s = (s << 8) | ((long)(seedBytes[i]) & 0xffL);
236 >            return s;
237          }
238 +        return (mix64(System.currentTimeMillis()) ^
239 +                mix64(System.nanoTime()));
240      }
241  
242      // IllegalArgumentException messages
# Line 361 | Line 363 | public class SplittableRandom {
363       * @param seed the initial seed
364       */
365      public SplittableRandom(long seed) {
366 <        this(seed, INITIAL_GAMMA);
366 >        this(seed, GOLDEN_GAMMA);
367      }
368  
369      /**
# Line 370 | Line 372 | public class SplittableRandom {
372       * of those of any other instances in the current program; and
373       * may, and typically does, vary across program invocations.
374       */
375 <    public SplittableRandom() { // emulate seeder.split()
376 <        this.gamma = nextGamma(this.seed = seeder.addAndGet(INITIAL_GAMMA));
375 >    public SplittableRandom() { // emulate defaultGen.split()
376 >        long s = defaultGen.getAndAdd(2 * GOLDEN_GAMMA);
377 >        this.seed = mix64(s);
378 >        this.gamma = mixGamma(s + GOLDEN_GAMMA);
379      }
380  
381      /**
# Line 389 | Line 393 | public class SplittableRandom {
393       * @return the new SplittableRandom instance
394       */
395      public SplittableRandom split() {
396 <        long s = nextSeed();
393 <        return new SplittableRandom(s, nextGamma(s));
396 >        return new SplittableRandom(nextLong(), mixGamma(nextSeed()));
397      }
398  
399      /**
# Line 406 | Line 409 | public class SplittableRandom {
409       * Returns a pseudorandom {@code int} value between zero (inclusive)
410       * and the specified bound (exclusive).
411       *
412 <     * @param bound the bound on the random number to be returned.  Must be
410 <     *        positive.
412 >     * @param bound the upper bound (exclusive).  Must be positive.
413       * @return a pseudorandom {@code int} value between zero
414       *         (inclusive) and the bound (exclusive)
415       * @throws IllegalArgumentException if {@code bound} is not positive
# Line 459 | Line 461 | public class SplittableRandom {
461       * Returns a pseudorandom {@code long} value between zero (inclusive)
462       * and the specified bound (exclusive).
463       *
464 <     * @param bound the bound on the random number to be returned.  Must be
463 <     *        positive.
464 >     * @param bound the upper bound (exclusive).  Must be positive.
465       * @return a pseudorandom {@code long} value between zero
466       *         (inclusive) and the bound (exclusive)
467       * @throws IllegalArgumentException if {@code bound} is not positive
# Line 504 | Line 505 | public class SplittableRandom {
505       * (inclusive) and one (exclusive).
506       *
507       * @return a pseudorandom {@code double} value between zero
508 <     * (inclusive) and one (exclusive)
508 >     *         (inclusive) and one (exclusive)
509       */
510      public double nextDouble() {
511          return (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT;
# Line 514 | Line 515 | public class SplittableRandom {
515       * Returns a pseudorandom {@code double} value between 0.0
516       * (inclusive) and the specified bound (exclusive).
517       *
518 <     * @param bound the bound on the random number to be returned.  Must be
518 <     *        positive.
518 >     * @param bound the upper bound (exclusive).  Must be positive.
519       * @return a pseudorandom {@code double} value between zero
520       *         (inclusive) and the bound (exclusive)
521       * @throws IllegalArgumentException if {@code bound} is not positive
# Line 533 | Line 533 | public class SplittableRandom {
533       * origin (inclusive) and bound (exclusive).
534       *
535       * @param origin the least value returned
536 <     * @param bound the upper bound
536 >     * @param bound the upper bound (exclusive)
537       * @return a pseudorandom {@code double} value between the origin
538       *         (inclusive) and the bound (exclusive)
539       * @throws IllegalArgumentException if {@code origin} is greater than
# Line 594 | Line 594 | public class SplittableRandom {
594  
595      /**
596       * Returns a stream producing the given {@code streamSize} number
597 <     * of pseudorandom {@code int} values, each conforming to the
598 <     * given origin and bound.
597 >     * of pseudorandom {@code int} values from this generator and/or one split
598 >     * from it; each value conforms to the given origin (inclusive) and bound
599 >     * (exclusive).
600       *
601       * @param streamSize the number of values to generate
602 <     * @param randomNumberOrigin the origin of each random value
603 <     * @param randomNumberBound the bound of each random value
602 >     * @param randomNumberOrigin the origin (inclusive) of each random value
603 >     * @param randomNumberBound the bound (exclusive) of each random value
604       * @return a stream of pseudorandom {@code int} values,
605 <     *         each with the given origin and bound
605 >     *         each with the given origin (inclusive) and bound (exclusive)
606       * @throws IllegalArgumentException if {@code streamSize} is
607       *         less than zero, or {@code randomNumberOrigin}
608       *         is greater than or equal to {@code randomNumberBound}
# Line 620 | Line 621 | public class SplittableRandom {
621  
622      /**
623       * Returns an effectively unlimited stream of pseudorandom {@code
624 <     * int} values, each conforming to the given origin and bound.
624 >     * int} values from this generator and/or one split from it; each value
625 >     * conforms to the given origin (inclusive) and bound (exclusive).
626       *
627       * @implNote This method is implemented to be equivalent to {@code
628       * ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
629       *
630 <     * @param randomNumberOrigin the origin of each random value
631 <     * @param randomNumberBound the bound of each random value
630 >     * @param randomNumberOrigin the origin (inclusive) of each random value
631 >     * @param randomNumberBound the bound (exclusive) of each random value
632       * @return a stream of pseudorandom {@code int} values,
633 <     *         each with the given origin and bound
633 >     *         each with the given origin (inclusive) and bound (exclusive)
634       * @throws IllegalArgumentException if {@code randomNumberOrigin}
635       *         is greater than or equal to {@code randomNumberBound}
636       */
# Line 678 | Line 680 | public class SplittableRandom {
680  
681      /**
682       * Returns a stream producing the given {@code streamSize} number of
683 <     * pseudorandom {@code long} values, each conforming to the
684 <     * given origin and bound.
683 >     * pseudorandom {@code long} values from this generator and/or one split
684 >     * from it; each value conforms to the given origin (inclusive) and bound
685 >     * (exclusive).
686       *
687       * @param streamSize the number of values to generate
688 <     * @param randomNumberOrigin the origin of each random value
689 <     * @param randomNumberBound the bound of each random value
688 >     * @param randomNumberOrigin the origin (inclusive) of each random value
689 >     * @param randomNumberBound the bound (exclusive) of each random value
690       * @return a stream of pseudorandom {@code long} values,
691 <     *         each with the given origin and bound
691 >     *         each with the given origin (inclusive) and bound (exclusive)
692       * @throws IllegalArgumentException if {@code streamSize} is
693       *         less than zero, or {@code randomNumberOrigin}
694       *         is greater than or equal to {@code randomNumberBound}
# Line 704 | Line 707 | public class SplittableRandom {
707  
708      /**
709       * Returns an effectively unlimited stream of pseudorandom {@code
710 <     * long} values, each conforming to the given origin and bound.
710 >     * long} values from this generator and/or one split from it; each value
711 >     * conforms to the given origin (inclusive) and bound (exclusive).
712       *
713       * @implNote This method is implemented to be equivalent to {@code
714       * longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
715       *
716 <     * @param randomNumberOrigin the origin of each random value
717 <     * @param randomNumberBound the bound of each random value
716 >     * @param randomNumberOrigin the origin (inclusive) of each random value
717 >     * @param randomNumberBound the bound (exclusive) of each random value
718       * @return a stream of pseudorandom {@code long} values,
719 <     *         each with the given origin and bound
719 >     *         each with the given origin (inclusive) and bound (exclusive)
720       * @throws IllegalArgumentException if {@code randomNumberOrigin}
721       *         is greater than or equal to {@code randomNumberBound}
722       */
# Line 727 | Line 731 | public class SplittableRandom {
731  
732      /**
733       * Returns a stream producing the given {@code streamSize} number of
734 <     * pseudorandom {@code double} values, each between zero
735 <     * (inclusive) and one (exclusive).
734 >     * pseudorandom {@code double} values from this generator and/or one split
735 >     * from it; each value is between zero (inclusive) and one (exclusive).
736       *
737       * @param streamSize the number of values to generate
738       * @return a stream of {@code double} values
# Line 746 | Line 750 | public class SplittableRandom {
750  
751      /**
752       * Returns an effectively unlimited stream of pseudorandom {@code
753 <     * double} values, each between zero (inclusive) and one
754 <     * (exclusive).
753 >     * double} values from this generator and/or one split from it; each value
754 >     * is between zero (inclusive) and one (exclusive).
755       *
756       * @implNote This method is implemented to be equivalent to {@code
757       * doubles(Long.MAX_VALUE)}.
# Line 763 | Line 767 | public class SplittableRandom {
767  
768      /**
769       * Returns a stream producing the given {@code streamSize} number of
770 <     * pseudorandom {@code double} values, each conforming to the
771 <     * given origin and bound.
770 >     * pseudorandom {@code double} values from this generator and/or one split
771 >     * from it; each value conforms to the given origin (inclusive) and bound
772 >     * (exclusive).
773       *
774       * @param streamSize the number of values to generate
775 <     * @param randomNumberOrigin the origin of each random value
776 <     * @param randomNumberBound the bound of each random value
775 >     * @param randomNumberOrigin the origin (inclusive) of each random value
776 >     * @param randomNumberBound the bound (exclusive) of each random value
777       * @return a stream of pseudorandom {@code double} values,
778 <     * each with the given origin and bound
778 >     *         each with the given origin (inclusive) and bound (exclusive)
779       * @throws IllegalArgumentException if {@code streamSize} is
780 <     * less than zero
780 >     *         less than zero
781       * @throws IllegalArgumentException if {@code randomNumberOrigin}
782       *         is greater than or equal to {@code randomNumberBound}
783       */
# Line 790 | Line 795 | public class SplittableRandom {
795  
796      /**
797       * Returns an effectively unlimited stream of pseudorandom {@code
798 <     * double} values, each conforming to the given origin and bound.
798 >     * double} values from this generator and/or one split from it; each value
799 >     * conforms to the given origin (inclusive) and bound (exclusive).
800       *
801       * @implNote This method is implemented to be equivalent to {@code
802       * doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
803       *
804 <     * @param randomNumberOrigin the origin of each random value
805 <     * @param randomNumberBound the bound of each random value
804 >     * @param randomNumberOrigin the origin (inclusive) of each random value
805 >     * @param randomNumberBound the bound (exclusive) of each random value
806       * @return a stream of pseudorandom {@code double} values,
807 <     * each with the given origin and bound
807 >     *         each with the given origin (inclusive) and bound (exclusive)
808       * @throws IllegalArgumentException if {@code randomNumberOrigin}
809       *         is greater than or equal to {@code randomNumberBound}
810       */

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines