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.39 by jsr166, Mon Feb 20 22:07:50 2017 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 54 | Line 52 | import java.util.stream.DoubleStream;
52   * types and ranges, but similar properties are expected to hold, at
53   * least approximately, for others as well. The <em>period</em>
54   * (length of any series of generated values before it repeats) is at
55 < * least 2<sup>64</sup>. </li>
55 > * least 2<sup>64</sup>.
56   *
57 < * <li> Method {@link #split} constructs and returns a new
57 > * <li>Method {@link #split} constructs and returns a new
58   * SplittableRandom instance that shares no mutable state with the
59   * current instance. However, with very high probability, the
60   * values collectively generated by the two objects have the same
61   * statistical properties as if the same quantity of values were
62   * generated by a single thread using a single {@code
63 < * SplittableRandom} object.  </li>
63 > * SplittableRandom} object.
64   *
65   * <li>Instances of SplittableRandom are <em>not</em> thread-safe.
66   * They are designed to be split, not shared, across threads. For
# Line 73 | Line 71 | import java.util.stream.DoubleStream;
71   *
72   * <li>This class provides additional methods for generating random
73   * streams, that employ the above techniques when used in {@code
74 < * stream.parallel()} mode.</li>
74 > * stream.parallel()} mode.
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 218 | Line 219 | public class SplittableRandom {
219          return seed += gamma;
220      }
221  
222 +    // IllegalArgumentException messages
223 +    static final String BAD_BOUND = "bound must be positive";
224 +    static final String BAD_RANGE = "bound must be greater than origin";
225 +    static final String BAD_SIZE  = "size must be non-negative";
226 +
227      /**
228       * The seed generator for default constructors.
229       */
230 <    private static final AtomicLong seeder =
231 <        new AtomicLong(mix64((((long)hashedHostAddress()) << 32) ^
232 <                             System.currentTimeMillis()) ^
233 <                       mix64(System.nanoTime()));
234 <
235 <    /**
236 <     * Returns hash of local host IP address, if available; else 0.
237 <     */
238 <    private static int hashedHostAddress() {
239 <        try {
240 <            return InetAddress.getLocalHost().hashCode();
241 <        } catch (Exception ex) {
242 <            return 0;
230 >    private static final AtomicLong defaultGen
231 >        = new AtomicLong(mix64(System.currentTimeMillis()) ^
232 >                         mix64(System.nanoTime()));
233 >
234 >    // at end of <clinit> to survive static initialization circularity
235 >    static {
236 >        if (java.security.AccessController.doPrivileged(
237 >            new java.security.PrivilegedAction<Boolean>() {
238 >                public Boolean run() {
239 >                    return Boolean.getBoolean("java.util.secureRandomSeed");
240 >                }})) {
241 >            byte[] seedBytes = java.security.SecureRandom.getSeed(8);
242 >            long s = (long)seedBytes[0] & 0xffL;
243 >            for (int i = 1; i < 8; ++i)
244 >                s = (s << 8) | ((long)seedBytes[i] & 0xffL);
245 >            defaultGen.set(s);
246          }
247      }
248  
240    // IllegalArgumentException messages
241    static final String BadBound = "bound must be positive";
242    static final String BadRange = "bound must be greater than origin";
243    static final String BadSize  = "size must be non-negative";
244
249      /*
250       * Internal versions of nextX methods used by streams, as well as
251       * the public nextX(origin, bound) methods.  These exist mainly to
# Line 361 | Line 365 | public class SplittableRandom {
365       * @param seed the initial seed
366       */
367      public SplittableRandom(long seed) {
368 <        this(seed, INITIAL_GAMMA);
368 >        this(seed, GOLDEN_GAMMA);
369      }
370  
371      /**
# Line 370 | Line 374 | public class SplittableRandom {
374       * of those of any other instances in the current program; and
375       * may, and typically does, vary across program invocations.
376       */
377 <    public SplittableRandom() { // emulate seeder.split()
378 <        this.gamma = nextGamma(this.seed = seeder.addAndGet(INITIAL_GAMMA));
377 >    public SplittableRandom() { // emulate defaultGen.split()
378 >        long s = defaultGen.getAndAdd(GOLDEN_GAMMA << 1);
379 >        this.seed = mix64(s);
380 >        this.gamma = mixGamma(s + GOLDEN_GAMMA);
381      }
382  
383      /**
# Line 389 | Line 395 | public class SplittableRandom {
395       * @return the new SplittableRandom instance
396       */
397      public SplittableRandom split() {
398 <        long s = nextSeed();
393 <        return new SplittableRandom(s, nextGamma(s));
398 >        return new SplittableRandom(nextLong(), mixGamma(nextSeed()));
399      }
400  
401      /**
# Line 406 | Line 411 | public class SplittableRandom {
411       * Returns a pseudorandom {@code int} value between zero (inclusive)
412       * and the specified bound (exclusive).
413       *
414 <     * @param bound the bound on the random number to be returned.  Must be
410 <     *        positive.
414 >     * @param bound the upper bound (exclusive).  Must be positive.
415       * @return a pseudorandom {@code int} value between zero
416       *         (inclusive) and the bound (exclusive)
417       * @throws IllegalArgumentException if {@code bound} is not positive
418       */
419      public int nextInt(int bound) {
420          if (bound <= 0)
421 <            throw new IllegalArgumentException(BadBound);
421 >            throw new IllegalArgumentException(BAD_BOUND);
422          // Specialize internalNextInt for origin 0
423          int r = mix32(nextSeed());
424          int m = bound - 1;
# Line 442 | Line 446 | public class SplittableRandom {
446       */
447      public int nextInt(int origin, int bound) {
448          if (origin >= bound)
449 <            throw new IllegalArgumentException(BadRange);
449 >            throw new IllegalArgumentException(BAD_RANGE);
450          return internalNextInt(origin, bound);
451      }
452  
# Line 459 | Line 463 | public class SplittableRandom {
463       * Returns a pseudorandom {@code long} value between zero (inclusive)
464       * and the specified bound (exclusive).
465       *
466 <     * @param bound the bound on the random number to be returned.  Must be
463 <     *        positive.
466 >     * @param bound the upper bound (exclusive).  Must be positive.
467       * @return a pseudorandom {@code long} value between zero
468       *         (inclusive) and the bound (exclusive)
469       * @throws IllegalArgumentException if {@code bound} is not positive
470       */
471      public long nextLong(long bound) {
472          if (bound <= 0)
473 <            throw new IllegalArgumentException(BadBound);
473 >            throw new IllegalArgumentException(BAD_BOUND);
474          // Specialize internalNextLong for origin 0
475          long r = mix64(nextSeed());
476          long m = bound - 1;
# Line 495 | Line 498 | public class SplittableRandom {
498       */
499      public long nextLong(long origin, long bound) {
500          if (origin >= bound)
501 <            throw new IllegalArgumentException(BadRange);
501 >            throw new IllegalArgumentException(BAD_RANGE);
502          return internalNextLong(origin, bound);
503      }
504  
# Line 504 | Line 507 | public class SplittableRandom {
507       * (inclusive) and one (exclusive).
508       *
509       * @return a pseudorandom {@code double} value between zero
510 <     * (inclusive) and one (exclusive)
510 >     *         (inclusive) and one (exclusive)
511       */
512      public double nextDouble() {
513          return (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT;
# Line 514 | Line 517 | public class SplittableRandom {
517       * Returns a pseudorandom {@code double} value between 0.0
518       * (inclusive) and the specified bound (exclusive).
519       *
520 <     * @param bound the bound on the random number to be returned.  Must be
518 <     *        positive.
520 >     * @param bound the upper bound (exclusive).  Must be positive.
521       * @return a pseudorandom {@code double} value between zero
522       *         (inclusive) and the bound (exclusive)
523       * @throws IllegalArgumentException if {@code bound} is not positive
524       */
525      public double nextDouble(double bound) {
526          if (!(bound > 0.0))
527 <            throw new IllegalArgumentException(BadBound);
527 >            throw new IllegalArgumentException(BAD_BOUND);
528          double result = (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT * bound;
529          return (result < bound) ?  result : // correct for rounding
530              Double.longBitsToDouble(Double.doubleToLongBits(bound) - 1);
# Line 533 | Line 535 | public class SplittableRandom {
535       * origin (inclusive) and bound (exclusive).
536       *
537       * @param origin the least value returned
538 <     * @param bound the upper bound
538 >     * @param bound the upper bound (exclusive)
539       * @return a pseudorandom {@code double} value between the origin
540       *         (inclusive) and the bound (exclusive)
541       * @throws IllegalArgumentException if {@code origin} is greater than
# Line 541 | Line 543 | public class SplittableRandom {
543       */
544      public double nextDouble(double origin, double bound) {
545          if (!(origin < bound))
546 <            throw new IllegalArgumentException(BadRange);
546 >            throw new IllegalArgumentException(BAD_RANGE);
547          return internalNextDouble(origin, bound);
548      }
549  
# Line 569 | Line 571 | public class SplittableRandom {
571       */
572      public IntStream ints(long streamSize) {
573          if (streamSize < 0L)
574 <            throw new IllegalArgumentException(BadSize);
574 >            throw new IllegalArgumentException(BAD_SIZE);
575          return StreamSupport.intStream
576              (new RandomIntsSpliterator
577               (this, 0L, streamSize, Integer.MAX_VALUE, 0),
# Line 594 | Line 596 | public class SplittableRandom {
596  
597      /**
598       * Returns a stream producing the given {@code streamSize} number
599 <     * of pseudorandom {@code int} values, each conforming to the
600 <     * given origin and bound.
599 >     * of pseudorandom {@code int} values from this generator and/or one split
600 >     * from it; each value conforms to the given origin (inclusive) and bound
601 >     * (exclusive).
602       *
603       * @param streamSize the number of values to generate
604 <     * @param randomNumberOrigin the origin of each random value
605 <     * @param randomNumberBound the bound of each random value
604 >     * @param randomNumberOrigin the origin (inclusive) of each random value
605 >     * @param randomNumberBound the bound (exclusive) of each random value
606       * @return a stream of pseudorandom {@code int} values,
607 <     *         each with the given origin and bound
607 >     *         each with the given origin (inclusive) and bound (exclusive)
608       * @throws IllegalArgumentException if {@code streamSize} is
609       *         less than zero, or {@code randomNumberOrigin}
610       *         is greater than or equal to {@code randomNumberBound}
# Line 609 | Line 612 | public class SplittableRandom {
612      public IntStream ints(long streamSize, int randomNumberOrigin,
613                            int randomNumberBound) {
614          if (streamSize < 0L)
615 <            throw new IllegalArgumentException(BadSize);
615 >            throw new IllegalArgumentException(BAD_SIZE);
616          if (randomNumberOrigin >= randomNumberBound)
617 <            throw new IllegalArgumentException(BadRange);
617 >            throw new IllegalArgumentException(BAD_RANGE);
618          return StreamSupport.intStream
619              (new RandomIntsSpliterator
620               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 620 | Line 623 | public class SplittableRandom {
623  
624      /**
625       * Returns an effectively unlimited stream of pseudorandom {@code
626 <     * int} values, each conforming to the given origin and bound.
626 >     * int} values from this generator and/or one split from it; each value
627 >     * conforms to the given origin (inclusive) and bound (exclusive).
628       *
629       * @implNote This method is implemented to be equivalent to {@code
630       * ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
631       *
632 <     * @param randomNumberOrigin the origin of each random value
633 <     * @param randomNumberBound the bound of each random value
632 >     * @param randomNumberOrigin the origin (inclusive) of each random value
633 >     * @param randomNumberBound the bound (exclusive) of each random value
634       * @return a stream of pseudorandom {@code int} values,
635 <     *         each with the given origin and bound
635 >     *         each with the given origin (inclusive) and bound (exclusive)
636       * @throws IllegalArgumentException if {@code randomNumberOrigin}
637       *         is greater than or equal to {@code randomNumberBound}
638       */
639      public IntStream ints(int randomNumberOrigin, int randomNumberBound) {
640          if (randomNumberOrigin >= randomNumberBound)
641 <            throw new IllegalArgumentException(BadRange);
641 >            throw new IllegalArgumentException(BAD_RANGE);
642          return StreamSupport.intStream
643              (new RandomIntsSpliterator
644               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 653 | Line 657 | public class SplittableRandom {
657       */
658      public LongStream longs(long streamSize) {
659          if (streamSize < 0L)
660 <            throw new IllegalArgumentException(BadSize);
660 >            throw new IllegalArgumentException(BAD_SIZE);
661          return StreamSupport.longStream
662              (new RandomLongsSpliterator
663               (this, 0L, streamSize, Long.MAX_VALUE, 0L),
# Line 678 | Line 682 | public class SplittableRandom {
682  
683      /**
684       * Returns a stream producing the given {@code streamSize} number of
685 <     * pseudorandom {@code long} values, each conforming to the
686 <     * given origin and bound.
685 >     * pseudorandom {@code long} values from this generator and/or one split
686 >     * from it; each value conforms to the given origin (inclusive) and bound
687 >     * (exclusive).
688       *
689       * @param streamSize the number of values to generate
690 <     * @param randomNumberOrigin the origin of each random value
691 <     * @param randomNumberBound the bound of each random value
690 >     * @param randomNumberOrigin the origin (inclusive) of each random value
691 >     * @param randomNumberBound the bound (exclusive) of each random value
692       * @return a stream of pseudorandom {@code long} values,
693 <     *         each with the given origin and bound
693 >     *         each with the given origin (inclusive) and bound (exclusive)
694       * @throws IllegalArgumentException if {@code streamSize} is
695       *         less than zero, or {@code randomNumberOrigin}
696       *         is greater than or equal to {@code randomNumberBound}
# Line 693 | Line 698 | public class SplittableRandom {
698      public LongStream longs(long streamSize, long randomNumberOrigin,
699                              long randomNumberBound) {
700          if (streamSize < 0L)
701 <            throw new IllegalArgumentException(BadSize);
701 >            throw new IllegalArgumentException(BAD_SIZE);
702          if (randomNumberOrigin >= randomNumberBound)
703 <            throw new IllegalArgumentException(BadRange);
703 >            throw new IllegalArgumentException(BAD_RANGE);
704          return StreamSupport.longStream
705              (new RandomLongsSpliterator
706               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 704 | Line 709 | public class SplittableRandom {
709  
710      /**
711       * Returns an effectively unlimited stream of pseudorandom {@code
712 <     * long} values, each conforming to the given origin and bound.
712 >     * long} values from this generator and/or one split from it; each value
713 >     * conforms to the given origin (inclusive) and bound (exclusive).
714       *
715       * @implNote This method is implemented to be equivalent to {@code
716       * longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
717       *
718 <     * @param randomNumberOrigin the origin of each random value
719 <     * @param randomNumberBound the bound of each random value
718 >     * @param randomNumberOrigin the origin (inclusive) of each random value
719 >     * @param randomNumberBound the bound (exclusive) of each random value
720       * @return a stream of pseudorandom {@code long} values,
721 <     *         each with the given origin and bound
721 >     *         each with the given origin (inclusive) and bound (exclusive)
722       * @throws IllegalArgumentException if {@code randomNumberOrigin}
723       *         is greater than or equal to {@code randomNumberBound}
724       */
725      public LongStream longs(long randomNumberOrigin, long randomNumberBound) {
726          if (randomNumberOrigin >= randomNumberBound)
727 <            throw new IllegalArgumentException(BadRange);
727 >            throw new IllegalArgumentException(BAD_RANGE);
728          return StreamSupport.longStream
729              (new RandomLongsSpliterator
730               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 727 | Line 733 | public class SplittableRandom {
733  
734      /**
735       * Returns a stream producing the given {@code streamSize} number of
736 <     * pseudorandom {@code double} values, each between zero
737 <     * (inclusive) and one (exclusive).
736 >     * pseudorandom {@code double} values from this generator and/or one split
737 >     * from it; each value is between zero (inclusive) and one (exclusive).
738       *
739       * @param streamSize the number of values to generate
740       * @return a stream of {@code double} values
# Line 737 | Line 743 | public class SplittableRandom {
743       */
744      public DoubleStream doubles(long streamSize) {
745          if (streamSize < 0L)
746 <            throw new IllegalArgumentException(BadSize);
746 >            throw new IllegalArgumentException(BAD_SIZE);
747          return StreamSupport.doubleStream
748              (new RandomDoublesSpliterator
749               (this, 0L, streamSize, Double.MAX_VALUE, 0.0),
# Line 746 | Line 752 | public class SplittableRandom {
752  
753      /**
754       * Returns an effectively unlimited stream of pseudorandom {@code
755 <     * double} values, each between zero (inclusive) and one
756 <     * (exclusive).
755 >     * double} values from this generator and/or one split from it; each value
756 >     * is between zero (inclusive) and one (exclusive).
757       *
758       * @implNote This method is implemented to be equivalent to {@code
759       * doubles(Long.MAX_VALUE)}.
# Line 763 | Line 769 | public class SplittableRandom {
769  
770      /**
771       * Returns a stream producing the given {@code streamSize} number of
772 <     * pseudorandom {@code double} values, each conforming to the
773 <     * given origin and bound.
772 >     * pseudorandom {@code double} values from this generator and/or one split
773 >     * from it; each value conforms to the given origin (inclusive) and bound
774 >     * (exclusive).
775       *
776       * @param streamSize the number of values to generate
777 <     * @param randomNumberOrigin the origin of each random value
778 <     * @param randomNumberBound the bound of each random value
777 >     * @param randomNumberOrigin the origin (inclusive) of each random value
778 >     * @param randomNumberBound the bound (exclusive) of each random value
779       * @return a stream of pseudorandom {@code double} values,
780 <     * each with the given origin and bound
780 >     *         each with the given origin (inclusive) and bound (exclusive)
781       * @throws IllegalArgumentException if {@code streamSize} is
782 <     * less than zero
776 <     * @throws IllegalArgumentException if {@code randomNumberOrigin}
782 >     *         less than zero, or {@code randomNumberOrigin}
783       *         is greater than or equal to {@code randomNumberBound}
784       */
785      public DoubleStream doubles(long streamSize, double randomNumberOrigin,
786                                  double randomNumberBound) {
787          if (streamSize < 0L)
788 <            throw new IllegalArgumentException(BadSize);
788 >            throw new IllegalArgumentException(BAD_SIZE);
789          if (!(randomNumberOrigin < randomNumberBound))
790 <            throw new IllegalArgumentException(BadRange);
790 >            throw new IllegalArgumentException(BAD_RANGE);
791          return StreamSupport.doubleStream
792              (new RandomDoublesSpliterator
793               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 790 | Line 796 | public class SplittableRandom {
796  
797      /**
798       * Returns an effectively unlimited stream of pseudorandom {@code
799 <     * double} values, each conforming to the given origin and bound.
799 >     * double} values from this generator and/or one split from it; each value
800 >     * conforms to the given origin (inclusive) and bound (exclusive).
801       *
802       * @implNote This method is implemented to be equivalent to {@code
803       * doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
804       *
805 <     * @param randomNumberOrigin the origin of each random value
806 <     * @param randomNumberBound the bound of each random value
805 >     * @param randomNumberOrigin the origin (inclusive) of each random value
806 >     * @param randomNumberBound the bound (exclusive) of each random value
807       * @return a stream of pseudorandom {@code double} values,
808 <     * each with the given origin and bound
808 >     *         each with the given origin (inclusive) and bound (exclusive)
809       * @throws IllegalArgumentException if {@code randomNumberOrigin}
810       *         is greater than or equal to {@code randomNumberBound}
811       */
812      public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) {
813          if (!(randomNumberOrigin < randomNumberBound))
814 <            throw new IllegalArgumentException(BadRange);
814 >            throw new IllegalArgumentException(BAD_RANGE);
815          return StreamSupport.doubleStream
816              (new RandomDoublesSpliterator
817               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 819 | Line 826 | public class SplittableRandom {
826       * approach. The long and double versions of this class are
827       * identical except for types.
828       */
829 <    static final class RandomIntsSpliterator implements Spliterator.OfInt {
829 >    private static final class RandomIntsSpliterator
830 >            implements Spliterator.OfInt {
831          final SplittableRandom rng;
832          long index;
833          final long fence;
# Line 874 | Line 882 | public class SplittableRandom {
882      /**
883       * Spliterator for long streams.
884       */
885 <    static final class RandomLongsSpliterator implements Spliterator.OfLong {
885 >    private static final class RandomLongsSpliterator
886 >            implements Spliterator.OfLong {
887          final SplittableRandom rng;
888          long index;
889          final long fence;
# Line 930 | Line 939 | public class SplittableRandom {
939      /**
940       * Spliterator for double streams.
941       */
942 <    static final class RandomDoublesSpliterator implements Spliterator.OfDouble {
942 >    private static final class RandomDoublesSpliterator
943 >            implements Spliterator.OfDouble {
944          final SplittableRandom rng;
945          long index;
946          final long fence;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines