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.15 by dl, Fri Aug 9 12:12:10 2013 UTC vs.
Revision 1.41 by jsr166, Sun Dec 2 23:06:16 2018 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 + * {@systemProperty 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;
243 <        }
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();
399 <        return new SplittableRandom(s, nextGamma(s));
398 >        return new SplittableRandom(nextLong(), mixGamma(nextSeed()));
399 >    }
400 >
401 >    /**
402 >     * Fills a user-supplied byte array with generated pseudorandom bytes.
403 >     *
404 >     * @param  bytes the byte array to fill with pseudorandom bytes
405 >     * @throws NullPointerException if bytes is null
406 >     * @since  10
407 >     */
408 >    public void nextBytes(byte[] bytes) {
409 >        int i = 0;
410 >        int len = bytes.length;
411 >        for (int words = len >> 3; words--> 0; ) {
412 >            long rnd = nextLong();
413 >            for (int n = 8; n--> 0; rnd >>>= Byte.SIZE)
414 >                bytes[i++] = (byte)rnd;
415 >        }
416 >        if (i < len)
417 >            for (long rnd = nextLong(); i < len; rnd >>>= Byte.SIZE)
418 >                bytes[i++] = (byte)rnd;
419      }
420  
421      /**
# Line 406 | Line 431 | public class SplittableRandom {
431       * Returns a pseudorandom {@code int} value between zero (inclusive)
432       * and the specified bound (exclusive).
433       *
434 <     * @param bound the bound on the random number to be returned.  Must be
410 <     *        positive.
434 >     * @param bound the upper bound (exclusive).  Must be positive.
435       * @return a pseudorandom {@code int} value between zero
436       *         (inclusive) and the bound (exclusive)
437 <     * @throws IllegalArgumentException if the bound is less than zero
437 >     * @throws IllegalArgumentException if {@code bound} is not positive
438       */
439      public int nextInt(int bound) {
440          if (bound <= 0)
441 <            throw new IllegalArgumentException(BadBound);
441 >            throw new IllegalArgumentException(BAD_BOUND);
442          // Specialize internalNextInt for origin 0
443          int r = mix32(nextSeed());
444          int m = bound - 1;
# Line 442 | Line 466 | public class SplittableRandom {
466       */
467      public int nextInt(int origin, int bound) {
468          if (origin >= bound)
469 <            throw new IllegalArgumentException(BadRange);
469 >            throw new IllegalArgumentException(BAD_RANGE);
470          return internalNextInt(origin, bound);
471      }
472  
# Line 459 | Line 483 | public class SplittableRandom {
483       * Returns a pseudorandom {@code long} value between zero (inclusive)
484       * and the specified bound (exclusive).
485       *
486 <     * @param bound the bound on the random number to be returned.  Must be
463 <     *        positive.
486 >     * @param bound the upper bound (exclusive).  Must be positive.
487       * @return a pseudorandom {@code long} value between zero
488       *         (inclusive) and the bound (exclusive)
489 <     * @throws IllegalArgumentException if {@code bound} is less than zero
489 >     * @throws IllegalArgumentException if {@code bound} is not positive
490       */
491      public long nextLong(long bound) {
492          if (bound <= 0)
493 <            throw new IllegalArgumentException(BadBound);
493 >            throw new IllegalArgumentException(BAD_BOUND);
494          // Specialize internalNextLong for origin 0
495          long r = mix64(nextSeed());
496          long m = bound - 1;
# Line 495 | Line 518 | public class SplittableRandom {
518       */
519      public long nextLong(long origin, long bound) {
520          if (origin >= bound)
521 <            throw new IllegalArgumentException(BadRange);
521 >            throw new IllegalArgumentException(BAD_RANGE);
522          return internalNextLong(origin, bound);
523      }
524  
# Line 504 | Line 527 | public class SplittableRandom {
527       * (inclusive) and one (exclusive).
528       *
529       * @return a pseudorandom {@code double} value between zero
530 <     * (inclusive) and one (exclusive)
530 >     *         (inclusive) and one (exclusive)
531       */
532      public double nextDouble() {
533          return (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT;
# Line 514 | Line 537 | public class SplittableRandom {
537       * Returns a pseudorandom {@code double} value between 0.0
538       * (inclusive) and the specified bound (exclusive).
539       *
540 <     * @param bound the bound on the random number to be returned.  Must be
518 <     *        positive.
540 >     * @param bound the upper bound (exclusive).  Must be positive.
541       * @return a pseudorandom {@code double} value between zero
542       *         (inclusive) and the bound (exclusive)
543 <     * @throws IllegalArgumentException if {@code bound} is less than zero
543 >     * @throws IllegalArgumentException if {@code bound} is not positive
544       */
545      public double nextDouble(double bound) {
546          if (!(bound > 0.0))
547 <            throw new IllegalArgumentException(BadBound);
547 >            throw new IllegalArgumentException(BAD_BOUND);
548          double result = (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT * bound;
549          return (result < bound) ?  result : // correct for rounding
550              Double.longBitsToDouble(Double.doubleToLongBits(bound) - 1);
# Line 533 | Line 555 | public class SplittableRandom {
555       * origin (inclusive) and bound (exclusive).
556       *
557       * @param origin the least value returned
558 <     * @param bound the upper bound
558 >     * @param bound the upper bound (exclusive)
559       * @return a pseudorandom {@code double} value between the origin
560       *         (inclusive) and the bound (exclusive)
561       * @throws IllegalArgumentException if {@code origin} is greater than
# Line 541 | Line 563 | public class SplittableRandom {
563       */
564      public double nextDouble(double origin, double bound) {
565          if (!(origin < bound))
566 <            throw new IllegalArgumentException(BadRange);
566 >            throw new IllegalArgumentException(BAD_RANGE);
567          return internalNextDouble(origin, bound);
568      }
569  
# Line 558 | Line 580 | public class SplittableRandom {
580      // maintenance purposes the small differences across forms.
581  
582      /**
583 <     * Returns a stream producing the given {@code streamSize} number of
584 <     * pseudorandom {@code int} values.
583 >     * Returns a stream producing the given {@code streamSize} number
584 >     * of pseudorandom {@code int} values from this generator and/or
585 >     * one split from it.
586       *
587       * @param streamSize the number of values to generate
588       * @return a stream of pseudorandom {@code int} values
# Line 568 | Line 591 | public class SplittableRandom {
591       */
592      public IntStream ints(long streamSize) {
593          if (streamSize < 0L)
594 <            throw new IllegalArgumentException(BadSize);
594 >            throw new IllegalArgumentException(BAD_SIZE);
595          return StreamSupport.intStream
596              (new RandomIntsSpliterator
597               (this, 0L, streamSize, Integer.MAX_VALUE, 0),
# Line 577 | Line 600 | public class SplittableRandom {
600  
601      /**
602       * Returns an effectively unlimited stream of pseudorandom {@code int}
603 <     * values.
603 >     * values from this generator and/or one split from it.
604       *
605       * @implNote This method is implemented to be equivalent to {@code
606       * ints(Long.MAX_VALUE)}.
# Line 592 | Line 615 | public class SplittableRandom {
615      }
616  
617      /**
618 <     * Returns a stream producing the given {@code streamSize} number of
619 <     * pseudorandom {@code int} values, each conforming to the given
620 <     * origin and bound.
618 >     * Returns a stream producing the given {@code streamSize} number
619 >     * of pseudorandom {@code int} values from this generator and/or one split
620 >     * from it; each value conforms to the given origin (inclusive) and bound
621 >     * (exclusive).
622       *
623       * @param streamSize the number of values to generate
624 <     * @param randomNumberOrigin the origin of each random value
625 <     * @param randomNumberBound the bound of each random value
624 >     * @param randomNumberOrigin the origin (inclusive) of each random value
625 >     * @param randomNumberBound the bound (exclusive) of each random value
626       * @return a stream of pseudorandom {@code int} values,
627 <     *         each with the given origin and bound
627 >     *         each with the given origin (inclusive) and bound (exclusive)
628       * @throws IllegalArgumentException if {@code streamSize} is
629       *         less than zero, or {@code randomNumberOrigin}
630       *         is greater than or equal to {@code randomNumberBound}
# Line 608 | Line 632 | public class SplittableRandom {
632      public IntStream ints(long streamSize, int randomNumberOrigin,
633                            int randomNumberBound) {
634          if (streamSize < 0L)
635 <            throw new IllegalArgumentException(BadSize);
635 >            throw new IllegalArgumentException(BAD_SIZE);
636          if (randomNumberOrigin >= randomNumberBound)
637 <            throw new IllegalArgumentException(BadRange);
637 >            throw new IllegalArgumentException(BAD_RANGE);
638          return StreamSupport.intStream
639              (new RandomIntsSpliterator
640               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 619 | Line 643 | public class SplittableRandom {
643  
644      /**
645       * Returns an effectively unlimited stream of pseudorandom {@code
646 <     * int} values, each conforming to the given origin and bound.
646 >     * int} values from this generator and/or one split from it; each value
647 >     * conforms to the given origin (inclusive) and bound (exclusive).
648       *
649       * @implNote This method is implemented to be equivalent to {@code
650       * ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
651       *
652 <     * @param randomNumberOrigin the origin of each random value
653 <     * @param randomNumberBound the bound of each random value
652 >     * @param randomNumberOrigin the origin (inclusive) of each random value
653 >     * @param randomNumberBound the bound (exclusive) of each random value
654       * @return a stream of pseudorandom {@code int} values,
655 <     *         each with the given origin and bound
655 >     *         each with the given origin (inclusive) and bound (exclusive)
656       * @throws IllegalArgumentException if {@code randomNumberOrigin}
657       *         is greater than or equal to {@code randomNumberBound}
658       */
659      public IntStream ints(int randomNumberOrigin, int randomNumberBound) {
660          if (randomNumberOrigin >= randomNumberBound)
661 <            throw new IllegalArgumentException(BadRange);
661 >            throw new IllegalArgumentException(BAD_RANGE);
662          return StreamSupport.intStream
663              (new RandomIntsSpliterator
664               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 641 | Line 666 | public class SplittableRandom {
666      }
667  
668      /**
669 <     * Returns a stream producing the given {@code streamSize} number of
670 <     * pseudorandom {@code long} values.
669 >     * Returns a stream producing the given {@code streamSize} number
670 >     * of pseudorandom {@code long} values from this generator and/or
671 >     * one split from it.
672       *
673       * @param streamSize the number of values to generate
674       * @return a stream of pseudorandom {@code long} values
# Line 651 | Line 677 | public class SplittableRandom {
677       */
678      public LongStream longs(long streamSize) {
679          if (streamSize < 0L)
680 <            throw new IllegalArgumentException(BadSize);
680 >            throw new IllegalArgumentException(BAD_SIZE);
681          return StreamSupport.longStream
682              (new RandomLongsSpliterator
683               (this, 0L, streamSize, Long.MAX_VALUE, 0L),
# Line 659 | Line 685 | public class SplittableRandom {
685      }
686  
687      /**
688 <     * Returns an effectively unlimited stream of pseudorandom {@code long}
689 <     * values.
688 >     * Returns an effectively unlimited stream of pseudorandom {@code
689 >     * long} values from this generator and/or one split from it.
690       *
691       * @implNote This method is implemented to be equivalent to {@code
692       * longs(Long.MAX_VALUE)}.
# Line 676 | Line 702 | public class SplittableRandom {
702  
703      /**
704       * Returns a stream producing the given {@code streamSize} number of
705 <     * pseudorandom {@code long} values, each conforming to the
706 <     * given origin and bound.
705 >     * pseudorandom {@code long} values from this generator and/or one split
706 >     * from it; each value conforms to the given origin (inclusive) and bound
707 >     * (exclusive).
708       *
709       * @param streamSize the number of values to generate
710 <     * @param randomNumberOrigin the origin of each random value
711 <     * @param randomNumberBound the bound of each random value
710 >     * @param randomNumberOrigin the origin (inclusive) of each random value
711 >     * @param randomNumberBound the bound (exclusive) of each random value
712       * @return a stream of pseudorandom {@code long} values,
713 <     *         each with the given origin and bound
713 >     *         each with the given origin (inclusive) and bound (exclusive)
714       * @throws IllegalArgumentException if {@code streamSize} is
715       *         less than zero, or {@code randomNumberOrigin}
716       *         is greater than or equal to {@code randomNumberBound}
# Line 691 | Line 718 | public class SplittableRandom {
718      public LongStream longs(long streamSize, long randomNumberOrigin,
719                              long randomNumberBound) {
720          if (streamSize < 0L)
721 <            throw new IllegalArgumentException(BadSize);
721 >            throw new IllegalArgumentException(BAD_SIZE);
722          if (randomNumberOrigin >= randomNumberBound)
723 <            throw new IllegalArgumentException(BadRange);
723 >            throw new IllegalArgumentException(BAD_RANGE);
724          return StreamSupport.longStream
725              (new RandomLongsSpliterator
726               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 702 | Line 729 | public class SplittableRandom {
729  
730      /**
731       * Returns an effectively unlimited stream of pseudorandom {@code
732 <     * long} values, each conforming to the given origin and bound.
732 >     * long} values from this generator and/or one split from it; each value
733 >     * conforms to the given origin (inclusive) and bound (exclusive).
734       *
735       * @implNote This method is implemented to be equivalent to {@code
736       * longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
737       *
738 <     * @param randomNumberOrigin the origin of each random value
739 <     * @param randomNumberBound the bound of each random value
738 >     * @param randomNumberOrigin the origin (inclusive) of each random value
739 >     * @param randomNumberBound the bound (exclusive) of each random value
740       * @return a stream of pseudorandom {@code long} values,
741 <     *         each with the given origin and bound
741 >     *         each with the given origin (inclusive) and bound (exclusive)
742       * @throws IllegalArgumentException if {@code randomNumberOrigin}
743       *         is greater than or equal to {@code randomNumberBound}
744       */
745      public LongStream longs(long randomNumberOrigin, long randomNumberBound) {
746          if (randomNumberOrigin >= randomNumberBound)
747 <            throw new IllegalArgumentException(BadRange);
747 >            throw new IllegalArgumentException(BAD_RANGE);
748          return StreamSupport.longStream
749              (new RandomLongsSpliterator
750               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 725 | Line 753 | public class SplittableRandom {
753  
754      /**
755       * Returns a stream producing the given {@code streamSize} number of
756 <     * pseudorandom {@code double} values, each between zero
757 <     * (inclusive) and one (exclusive).
756 >     * pseudorandom {@code double} values from this generator and/or one split
757 >     * from it; each value is between zero (inclusive) and one (exclusive).
758       *
759       * @param streamSize the number of values to generate
760       * @return a stream of {@code double} values
# Line 735 | Line 763 | public class SplittableRandom {
763       */
764      public DoubleStream doubles(long streamSize) {
765          if (streamSize < 0L)
766 <            throw new IllegalArgumentException(BadSize);
766 >            throw new IllegalArgumentException(BAD_SIZE);
767          return StreamSupport.doubleStream
768              (new RandomDoublesSpliterator
769               (this, 0L, streamSize, Double.MAX_VALUE, 0.0),
# Line 744 | Line 772 | public class SplittableRandom {
772  
773      /**
774       * Returns an effectively unlimited stream of pseudorandom {@code
775 <     * double} values, each between zero (inclusive) and one
776 <     * (exclusive).
775 >     * double} values from this generator and/or one split from it; each value
776 >     * is between zero (inclusive) and one (exclusive).
777       *
778       * @implNote This method is implemented to be equivalent to {@code
779       * doubles(Long.MAX_VALUE)}.
# Line 761 | Line 789 | public class SplittableRandom {
789  
790      /**
791       * Returns a stream producing the given {@code streamSize} number of
792 <     * pseudorandom {@code double} values, each conforming to the
793 <     * given origin and bound.
792 >     * pseudorandom {@code double} values from this generator and/or one split
793 >     * from it; each value conforms to the given origin (inclusive) and bound
794 >     * (exclusive).
795       *
796       * @param streamSize the number of values to generate
797 <     * @param randomNumberOrigin the origin of each random value
798 <     * @param randomNumberBound the bound of each random value
797 >     * @param randomNumberOrigin the origin (inclusive) of each random value
798 >     * @param randomNumberBound the bound (exclusive) of each random value
799       * @return a stream of pseudorandom {@code double} values,
800 <     * each with the given origin and bound
800 >     *         each with the given origin (inclusive) and bound (exclusive)
801       * @throws IllegalArgumentException if {@code streamSize} is
802 <     * less than zero
774 <     * @throws IllegalArgumentException if {@code randomNumberOrigin}
802 >     *         less than zero, or {@code randomNumberOrigin}
803       *         is greater than or equal to {@code randomNumberBound}
804       */
805      public DoubleStream doubles(long streamSize, double randomNumberOrigin,
806                                  double randomNumberBound) {
807          if (streamSize < 0L)
808 <            throw new IllegalArgumentException(BadSize);
808 >            throw new IllegalArgumentException(BAD_SIZE);
809          if (!(randomNumberOrigin < randomNumberBound))
810 <            throw new IllegalArgumentException(BadRange);
810 >            throw new IllegalArgumentException(BAD_RANGE);
811          return StreamSupport.doubleStream
812              (new RandomDoublesSpliterator
813               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 788 | Line 816 | public class SplittableRandom {
816  
817      /**
818       * Returns an effectively unlimited stream of pseudorandom {@code
819 <     * double} values, each conforming to the given origin and bound.
819 >     * double} values from this generator and/or one split from it; each value
820 >     * conforms to the given origin (inclusive) and bound (exclusive).
821       *
822       * @implNote This method is implemented to be equivalent to {@code
823       * doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
824       *
825 <     * @param randomNumberOrigin the origin of each random value
826 <     * @param randomNumberBound the bound of each random value
825 >     * @param randomNumberOrigin the origin (inclusive) of each random value
826 >     * @param randomNumberBound the bound (exclusive) of each random value
827       * @return a stream of pseudorandom {@code double} values,
828 <     * each with the given origin and bound
828 >     *         each with the given origin (inclusive) and bound (exclusive)
829       * @throws IllegalArgumentException if {@code randomNumberOrigin}
830       *         is greater than or equal to {@code randomNumberBound}
831       */
832      public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) {
833          if (!(randomNumberOrigin < randomNumberBound))
834 <            throw new IllegalArgumentException(BadRange);
834 >            throw new IllegalArgumentException(BAD_RANGE);
835          return StreamSupport.doubleStream
836              (new RandomDoublesSpliterator
837               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 817 | Line 846 | public class SplittableRandom {
846       * approach. The long and double versions of this class are
847       * identical except for types.
848       */
849 <    static final class RandomIntsSpliterator implements Spliterator.OfInt {
849 >    private static final class RandomIntsSpliterator
850 >            implements Spliterator.OfInt {
851          final SplittableRandom rng;
852          long index;
853          final long fence;
# Line 872 | Line 902 | public class SplittableRandom {
902      /**
903       * Spliterator for long streams.
904       */
905 <    static final class RandomLongsSpliterator implements Spliterator.OfLong {
905 >    private static final class RandomLongsSpliterator
906 >            implements Spliterator.OfLong {
907          final SplittableRandom rng;
908          long index;
909          final long fence;
# Line 928 | Line 959 | public class SplittableRandom {
959      /**
960       * Spliterator for double streams.
961       */
962 <    static final class RandomDoublesSpliterator implements Spliterator.OfDouble {
962 >    private static final class RandomDoublesSpliterator
963 >            implements Spliterator.OfDouble {
964          final SplittableRandom rng;
965          long index;
966          final long fence;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines