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.30 by jsr166, Sat Jan 2 02:27:03 2016 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 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;
235 <        }
227 >    private static long initialSeed() {
228 >        java.security.PrivilegedAction<Boolean> action =
229 >            () -> Boolean.getBoolean("java.util.secureRandomSeed");
230 >        if (java.security.AccessController.doPrivileged(action)) {
231 >            byte[] seedBytes = java.security.SecureRandom.getSeed(8);
232 >            long s = (long)seedBytes[0] & 0xffL;
233 >            for (int i = 1; i < 8; ++i)
234 >                s = (s << 8) | ((long)seedBytes[i] & 0xffL);
235 >            return s;
236 >        }
237 >        return (mix64(System.currentTimeMillis()) ^
238 >                mix64(System.nanoTime()));
239      }
240  
241      // IllegalArgumentException messages
242 <    static final String BadBound = "bound must be positive";
243 <    static final String BadRange = "bound must be greater than origin";
244 <    static final String BadSize  = "size must be non-negative";
242 >    static final String BAD_BOUND = "bound must be positive";
243 >    static final String BAD_RANGE = "bound must be greater than origin";
244 >    static final String BAD_SIZE  = "size must be non-negative";
245  
246      /*
247       * Internal versions of nextX methods used by streams, as well as
# Line 361 | Line 362 | public class SplittableRandom {
362       * @param seed the initial seed
363       */
364      public SplittableRandom(long seed) {
365 <        this(seed, INITIAL_GAMMA);
365 >        this(seed, GOLDEN_GAMMA);
366      }
367  
368      /**
# Line 370 | Line 371 | public class SplittableRandom {
371       * of those of any other instances in the current program; and
372       * may, and typically does, vary across program invocations.
373       */
374 <    public SplittableRandom() { // emulate seeder.split()
375 <        this.gamma = nextGamma(this.seed = seeder.addAndGet(INITIAL_GAMMA));
374 >    public SplittableRandom() { // emulate defaultGen.split()
375 >        long s = defaultGen.getAndAdd(2 * GOLDEN_GAMMA);
376 >        this.seed = mix64(s);
377 >        this.gamma = mixGamma(s + GOLDEN_GAMMA);
378      }
379  
380      /**
# Line 389 | Line 392 | public class SplittableRandom {
392       * @return the new SplittableRandom instance
393       */
394      public SplittableRandom split() {
395 <        long s = nextSeed();
393 <        return new SplittableRandom(s, nextGamma(s));
395 >        return new SplittableRandom(nextLong(), mixGamma(nextSeed()));
396      }
397  
398      /**
# Line 406 | Line 408 | public class SplittableRandom {
408       * Returns a pseudorandom {@code int} value between zero (inclusive)
409       * and the specified bound (exclusive).
410       *
411 <     * @param bound the bound on the random number to be returned.  Must be
410 <     *        positive.
411 >     * @param bound the upper bound (exclusive).  Must be positive.
412       * @return a pseudorandom {@code int} value between zero
413       *         (inclusive) and the bound (exclusive)
414 <     * @throws IllegalArgumentException if the bound is less than zero
414 >     * @throws IllegalArgumentException if {@code bound} is not positive
415       */
416      public int nextInt(int bound) {
417          if (bound <= 0)
418 <            throw new IllegalArgumentException(BadBound);
418 >            throw new IllegalArgumentException(BAD_BOUND);
419          // Specialize internalNextInt for origin 0
420          int r = mix32(nextSeed());
421          int m = bound - 1;
# Line 442 | Line 443 | public class SplittableRandom {
443       */
444      public int nextInt(int origin, int bound) {
445          if (origin >= bound)
446 <            throw new IllegalArgumentException(BadRange);
446 >            throw new IllegalArgumentException(BAD_RANGE);
447          return internalNextInt(origin, bound);
448      }
449  
# Line 459 | Line 460 | public class SplittableRandom {
460       * Returns a pseudorandom {@code long} value between zero (inclusive)
461       * and the specified bound (exclusive).
462       *
463 <     * @param bound the bound on the random number to be returned.  Must be
463 <     *        positive.
463 >     * @param bound the upper bound (exclusive).  Must be positive.
464       * @return a pseudorandom {@code long} value between zero
465       *         (inclusive) and the bound (exclusive)
466 <     * @throws IllegalArgumentException if {@code bound} is less than zero
466 >     * @throws IllegalArgumentException if {@code bound} is not positive
467       */
468      public long nextLong(long bound) {
469          if (bound <= 0)
470 <            throw new IllegalArgumentException(BadBound);
470 >            throw new IllegalArgumentException(BAD_BOUND);
471          // Specialize internalNextLong for origin 0
472          long r = mix64(nextSeed());
473          long m = bound - 1;
# Line 495 | Line 495 | public class SplittableRandom {
495       */
496      public long nextLong(long origin, long bound) {
497          if (origin >= bound)
498 <            throw new IllegalArgumentException(BadRange);
498 >            throw new IllegalArgumentException(BAD_RANGE);
499          return internalNextLong(origin, bound);
500      }
501  
# Line 504 | Line 504 | public class SplittableRandom {
504       * (inclusive) and one (exclusive).
505       *
506       * @return a pseudorandom {@code double} value between zero
507 <     * (inclusive) and one (exclusive)
507 >     *         (inclusive) and one (exclusive)
508       */
509      public double nextDouble() {
510          return (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT;
# Line 514 | Line 514 | public class SplittableRandom {
514       * Returns a pseudorandom {@code double} value between 0.0
515       * (inclusive) and the specified bound (exclusive).
516       *
517 <     * @param bound the bound on the random number to be returned.  Must be
518 <     *        positive.
517 >     * @param bound the upper bound (exclusive).  Must be positive.
518       * @return a pseudorandom {@code double} value between zero
519       *         (inclusive) and the bound (exclusive)
520 <     * @throws IllegalArgumentException if {@code bound} is less than zero
520 >     * @throws IllegalArgumentException if {@code bound} is not positive
521       */
522      public double nextDouble(double bound) {
523          if (!(bound > 0.0))
524 <            throw new IllegalArgumentException(BadBound);
524 >            throw new IllegalArgumentException(BAD_BOUND);
525          double result = (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT * bound;
526          return (result < bound) ?  result : // correct for rounding
527              Double.longBitsToDouble(Double.doubleToLongBits(bound) - 1);
# Line 533 | Line 532 | public class SplittableRandom {
532       * origin (inclusive) and bound (exclusive).
533       *
534       * @param origin the least value returned
535 <     * @param bound the upper bound
535 >     * @param bound the upper bound (exclusive)
536       * @return a pseudorandom {@code double} value between the origin
537       *         (inclusive) and the bound (exclusive)
538       * @throws IllegalArgumentException if {@code origin} is greater than
# Line 541 | Line 540 | public class SplittableRandom {
540       */
541      public double nextDouble(double origin, double bound) {
542          if (!(origin < bound))
543 <            throw new IllegalArgumentException(BadRange);
543 >            throw new IllegalArgumentException(BAD_RANGE);
544          return internalNextDouble(origin, bound);
545      }
546  
# Line 558 | Line 557 | public class SplittableRandom {
557      // maintenance purposes the small differences across forms.
558  
559      /**
560 <     * Returns a stream producing the given {@code streamSize} number of
561 <     * pseudorandom {@code int} values.
560 >     * Returns a stream producing the given {@code streamSize} number
561 >     * of pseudorandom {@code int} values from this generator and/or
562 >     * one split from it.
563       *
564       * @param streamSize the number of values to generate
565       * @return a stream of pseudorandom {@code int} values
# Line 568 | Line 568 | public class SplittableRandom {
568       */
569      public IntStream ints(long streamSize) {
570          if (streamSize < 0L)
571 <            throw new IllegalArgumentException(BadSize);
571 >            throw new IllegalArgumentException(BAD_SIZE);
572          return StreamSupport.intStream
573              (new RandomIntsSpliterator
574               (this, 0L, streamSize, Integer.MAX_VALUE, 0),
# Line 577 | Line 577 | public class SplittableRandom {
577  
578      /**
579       * Returns an effectively unlimited stream of pseudorandom {@code int}
580 <     * values.
580 >     * values from this generator and/or one split from it.
581       *
582       * @implNote This method is implemented to be equivalent to {@code
583       * ints(Long.MAX_VALUE)}.
# Line 592 | Line 592 | public class SplittableRandom {
592      }
593  
594      /**
595 <     * Returns a stream producing the given {@code streamSize} number of
596 <     * pseudorandom {@code int} values, each conforming to the given
597 <     * origin and bound.
595 >     * Returns a stream producing the given {@code streamSize} number
596 >     * of pseudorandom {@code int} values from this generator and/or one split
597 >     * from it; each value conforms to the given origin (inclusive) and bound
598 >     * (exclusive).
599       *
600       * @param streamSize the number of values to generate
601 <     * @param randomNumberOrigin the origin of each random value
602 <     * @param randomNumberBound the bound of each random value
601 >     * @param randomNumberOrigin the origin (inclusive) of each random value
602 >     * @param randomNumberBound the bound (exclusive) of each random value
603       * @return a stream of pseudorandom {@code int} values,
604 <     *         each with the given origin and bound
604 >     *         each with the given origin (inclusive) and bound (exclusive)
605       * @throws IllegalArgumentException if {@code streamSize} is
606       *         less than zero, or {@code randomNumberOrigin}
607       *         is greater than or equal to {@code randomNumberBound}
# Line 608 | Line 609 | public class SplittableRandom {
609      public IntStream ints(long streamSize, int randomNumberOrigin,
610                            int randomNumberBound) {
611          if (streamSize < 0L)
612 <            throw new IllegalArgumentException(BadSize);
612 >            throw new IllegalArgumentException(BAD_SIZE);
613          if (randomNumberOrigin >= randomNumberBound)
614 <            throw new IllegalArgumentException(BadRange);
614 >            throw new IllegalArgumentException(BAD_RANGE);
615          return StreamSupport.intStream
616              (new RandomIntsSpliterator
617               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 619 | Line 620 | public class SplittableRandom {
620  
621      /**
622       * Returns an effectively unlimited stream of pseudorandom {@code
623 <     * int} values, each conforming to the given origin and bound.
623 >     * int} values from this generator and/or one split from it; each value
624 >     * conforms to the given origin (inclusive) and bound (exclusive).
625       *
626       * @implNote This method is implemented to be equivalent to {@code
627       * ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
628       *
629 <     * @param randomNumberOrigin the origin of each random value
630 <     * @param randomNumberBound the bound of each random value
629 >     * @param randomNumberOrigin the origin (inclusive) of each random value
630 >     * @param randomNumberBound the bound (exclusive) of each random value
631       * @return a stream of pseudorandom {@code int} values,
632 <     *         each with the given origin and bound
632 >     *         each with the given origin (inclusive) and bound (exclusive)
633       * @throws IllegalArgumentException if {@code randomNumberOrigin}
634       *         is greater than or equal to {@code randomNumberBound}
635       */
636      public IntStream ints(int randomNumberOrigin, int randomNumberBound) {
637          if (randomNumberOrigin >= randomNumberBound)
638 <            throw new IllegalArgumentException(BadRange);
638 >            throw new IllegalArgumentException(BAD_RANGE);
639          return StreamSupport.intStream
640              (new RandomIntsSpliterator
641               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 641 | Line 643 | public class SplittableRandom {
643      }
644  
645      /**
646 <     * Returns a stream producing the given {@code streamSize} number of
647 <     * pseudorandom {@code long} values.
646 >     * Returns a stream producing the given {@code streamSize} number
647 >     * of pseudorandom {@code long} values from this generator and/or
648 >     * one split from it.
649       *
650       * @param streamSize the number of values to generate
651       * @return a stream of pseudorandom {@code long} values
# Line 651 | Line 654 | public class SplittableRandom {
654       */
655      public LongStream longs(long streamSize) {
656          if (streamSize < 0L)
657 <            throw new IllegalArgumentException(BadSize);
657 >            throw new IllegalArgumentException(BAD_SIZE);
658          return StreamSupport.longStream
659              (new RandomLongsSpliterator
660               (this, 0L, streamSize, Long.MAX_VALUE, 0L),
# Line 659 | Line 662 | public class SplittableRandom {
662      }
663  
664      /**
665 <     * Returns an effectively unlimited stream of pseudorandom {@code long}
666 <     * values.
665 >     * Returns an effectively unlimited stream of pseudorandom {@code
666 >     * long} values from this generator and/or one split from it.
667       *
668       * @implNote This method is implemented to be equivalent to {@code
669       * longs(Long.MAX_VALUE)}.
# Line 676 | Line 679 | public class SplittableRandom {
679  
680      /**
681       * Returns a stream producing the given {@code streamSize} number of
682 <     * pseudorandom {@code long} values, each conforming to the
683 <     * given origin and bound.
682 >     * pseudorandom {@code long} values from this generator and/or one split
683 >     * from it; each value conforms to the given origin (inclusive) and bound
684 >     * (exclusive).
685       *
686       * @param streamSize the number of values to generate
687 <     * @param randomNumberOrigin the origin of each random value
688 <     * @param randomNumberBound the bound of each random value
687 >     * @param randomNumberOrigin the origin (inclusive) of each random value
688 >     * @param randomNumberBound the bound (exclusive) of each random value
689       * @return a stream of pseudorandom {@code long} values,
690 <     *         each with the given origin and bound
690 >     *         each with the given origin (inclusive) and bound (exclusive)
691       * @throws IllegalArgumentException if {@code streamSize} is
692       *         less than zero, or {@code randomNumberOrigin}
693       *         is greater than or equal to {@code randomNumberBound}
# Line 691 | Line 695 | public class SplittableRandom {
695      public LongStream longs(long streamSize, long randomNumberOrigin,
696                              long randomNumberBound) {
697          if (streamSize < 0L)
698 <            throw new IllegalArgumentException(BadSize);
698 >            throw new IllegalArgumentException(BAD_SIZE);
699          if (randomNumberOrigin >= randomNumberBound)
700 <            throw new IllegalArgumentException(BadRange);
700 >            throw new IllegalArgumentException(BAD_RANGE);
701          return StreamSupport.longStream
702              (new RandomLongsSpliterator
703               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 702 | Line 706 | public class SplittableRandom {
706  
707      /**
708       * Returns an effectively unlimited stream of pseudorandom {@code
709 <     * long} values, each conforming to the given origin and bound.
709 >     * long} values from this generator and/or one split from it; each value
710 >     * conforms to the given origin (inclusive) and bound (exclusive).
711       *
712       * @implNote This method is implemented to be equivalent to {@code
713       * longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
714       *
715 <     * @param randomNumberOrigin the origin of each random value
716 <     * @param randomNumberBound the bound of each random value
715 >     * @param randomNumberOrigin the origin (inclusive) of each random value
716 >     * @param randomNumberBound the bound (exclusive) of each random value
717       * @return a stream of pseudorandom {@code long} values,
718 <     *         each with the given origin and bound
718 >     *         each with the given origin (inclusive) and bound (exclusive)
719       * @throws IllegalArgumentException if {@code randomNumberOrigin}
720       *         is greater than or equal to {@code randomNumberBound}
721       */
722      public LongStream longs(long randomNumberOrigin, long randomNumberBound) {
723          if (randomNumberOrigin >= randomNumberBound)
724 <            throw new IllegalArgumentException(BadRange);
724 >            throw new IllegalArgumentException(BAD_RANGE);
725          return StreamSupport.longStream
726              (new RandomLongsSpliterator
727               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 725 | Line 730 | public class SplittableRandom {
730  
731      /**
732       * Returns a stream producing the given {@code streamSize} number of
733 <     * pseudorandom {@code double} values, each between zero
734 <     * (inclusive) and one (exclusive).
733 >     * pseudorandom {@code double} values from this generator and/or one split
734 >     * from it; each value is between zero (inclusive) and one (exclusive).
735       *
736       * @param streamSize the number of values to generate
737       * @return a stream of {@code double} values
# Line 735 | Line 740 | public class SplittableRandom {
740       */
741      public DoubleStream doubles(long streamSize) {
742          if (streamSize < 0L)
743 <            throw new IllegalArgumentException(BadSize);
743 >            throw new IllegalArgumentException(BAD_SIZE);
744          return StreamSupport.doubleStream
745              (new RandomDoublesSpliterator
746               (this, 0L, streamSize, Double.MAX_VALUE, 0.0),
# Line 744 | Line 749 | public class SplittableRandom {
749  
750      /**
751       * Returns an effectively unlimited stream of pseudorandom {@code
752 <     * double} values, each between zero (inclusive) and one
753 <     * (exclusive).
752 >     * double} values from this generator and/or one split from it; each value
753 >     * is between zero (inclusive) and one (exclusive).
754       *
755       * @implNote This method is implemented to be equivalent to {@code
756       * doubles(Long.MAX_VALUE)}.
# Line 761 | Line 766 | public class SplittableRandom {
766  
767      /**
768       * Returns a stream producing the given {@code streamSize} number of
769 <     * pseudorandom {@code double} values, each conforming to the
770 <     * given origin and bound.
769 >     * pseudorandom {@code double} values from this generator and/or one split
770 >     * from it; each value conforms to the given origin (inclusive) and bound
771 >     * (exclusive).
772       *
773       * @param streamSize the number of values to generate
774 <     * @param randomNumberOrigin the origin of each random value
775 <     * @param randomNumberBound the bound of each random value
774 >     * @param randomNumberOrigin the origin (inclusive) of each random value
775 >     * @param randomNumberBound the bound (exclusive) of each random value
776       * @return a stream of pseudorandom {@code double} values,
777 <     * each with the given origin and bound
777 >     *         each with the given origin (inclusive) and bound (exclusive)
778       * @throws IllegalArgumentException if {@code streamSize} is
779 <     * less than zero
779 >     *         less than zero
780       * @throws IllegalArgumentException if {@code randomNumberOrigin}
781       *         is greater than or equal to {@code randomNumberBound}
782       */
783      public DoubleStream doubles(long streamSize, double randomNumberOrigin,
784                                  double randomNumberBound) {
785          if (streamSize < 0L)
786 <            throw new IllegalArgumentException(BadSize);
786 >            throw new IllegalArgumentException(BAD_SIZE);
787          if (!(randomNumberOrigin < randomNumberBound))
788 <            throw new IllegalArgumentException(BadRange);
788 >            throw new IllegalArgumentException(BAD_RANGE);
789          return StreamSupport.doubleStream
790              (new RandomDoublesSpliterator
791               (this, 0L, streamSize, randomNumberOrigin, randomNumberBound),
# Line 788 | Line 794 | public class SplittableRandom {
794  
795      /**
796       * Returns an effectively unlimited stream of pseudorandom {@code
797 <     * double} values, each conforming to the given origin and bound.
797 >     * double} values from this generator and/or one split from it; each value
798 >     * conforms to the given origin (inclusive) and bound (exclusive).
799       *
800       * @implNote This method is implemented to be equivalent to {@code
801       * doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
802       *
803 <     * @param randomNumberOrigin the origin of each random value
804 <     * @param randomNumberBound the bound of each random value
803 >     * @param randomNumberOrigin the origin (inclusive) of each random value
804 >     * @param randomNumberBound the bound (exclusive) of each random value
805       * @return a stream of pseudorandom {@code double} values,
806 <     * each with the given origin and bound
806 >     *         each with the given origin (inclusive) and bound (exclusive)
807       * @throws IllegalArgumentException if {@code randomNumberOrigin}
808       *         is greater than or equal to {@code randomNumberBound}
809       */
810      public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) {
811          if (!(randomNumberOrigin < randomNumberBound))
812 <            throw new IllegalArgumentException(BadRange);
812 >            throw new IllegalArgumentException(BAD_RANGE);
813          return StreamSupport.doubleStream
814              (new RandomDoublesSpliterator
815               (this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound),
# Line 817 | Line 824 | public class SplittableRandom {
824       * approach. The long and double versions of this class are
825       * identical except for types.
826       */
827 <    static final class RandomIntsSpliterator implements Spliterator.OfInt {
827 >    private static final class RandomIntsSpliterator
828 >            implements Spliterator.OfInt {
829          final SplittableRandom rng;
830          long index;
831          final long fence;
# Line 872 | Line 880 | public class SplittableRandom {
880      /**
881       * Spliterator for long streams.
882       */
883 <    static final class RandomLongsSpliterator implements Spliterator.OfLong {
883 >    private static final class RandomLongsSpliterator
884 >            implements Spliterator.OfLong {
885          final SplittableRandom rng;
886          long index;
887          final long fence;
# Line 928 | Line 937 | public class SplittableRandom {
937      /**
938       * Spliterator for double streams.
939       */
940 <    static final class RandomDoublesSpliterator implements Spliterator.OfDouble {
940 >    private static final class RandomDoublesSpliterator
941 >            implements Spliterator.OfDouble {
942          final SplittableRandom rng;
943          long index;
944          final long fence;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines