25 |
|
|
26 |
|
package java.util; |
27 |
|
|
28 |
+ |
import java.net.InetAddress; |
29 |
|
import java.util.concurrent.atomic.AtomicLong; |
30 |
|
import java.util.Spliterator; |
31 |
|
import java.util.function.IntConsumer; |
42 |
|
* generate subtasks. Class SplittableRandom supports methods for |
43 |
|
* producing pseudorandom numbers of type {@code int}, {@code long}, |
44 |
|
* and {@code double} with similar usages as for class |
45 |
< |
* {@link java.util.Random} but differs in the following ways: <ul> |
45 |
> |
* {@link java.util.Random} but differs in the following ways: |
46 |
> |
* |
47 |
> |
* <ul> |
48 |
|
* |
49 |
|
* <li>Series of generated values pass the DieHarder suite testing |
50 |
|
* independence and uniformity properties of random number generators. |
52 |
|
* href="http://www.phy.duke.edu/~rgb/General/dieharder.php"> version |
53 |
|
* 3.31.1</a>.) These tests validate only the methods for certain |
54 |
|
* types and ranges, but similar properties are expected to hold, at |
55 |
< |
* least approximately, for others as well. </li> |
55 |
> |
* least approximately, for others as well. The <em>period</em> |
56 |
> |
* (length of any series of generated values before it repeats) is at |
57 |
> |
* least 2<sup>64</sup>. </li> |
58 |
|
* |
59 |
|
* <li> Method {@link #split} constructs and returns a new |
60 |
|
* SplittableRandom instance that shares no mutable state with the |
84 |
|
public class SplittableRandom { |
85 |
|
|
86 |
|
/* |
82 |
– |
* File organization: First the non-public methods that constitute |
83 |
– |
* the main algorithm, then the main public methods, followed by |
84 |
– |
* some custom spliterator classes needed for stream methods. |
85 |
– |
* |
86 |
– |
* Credits: Primary algorithm and code by Guy Steele. Stream |
87 |
– |
* support methods by Doug Lea. Documentation jointly produced |
88 |
– |
* with additional help from Brian Goetz. |
89 |
– |
*/ |
90 |
– |
|
91 |
– |
/* |
87 |
|
* Implementation Overview. |
88 |
|
* |
89 |
|
* This algorithm was inspired by the "DotMix" algorithm by |
90 |
|
* Leiserson, Schardl, and Sukha "Deterministic Parallel |
91 |
|
* Random-Number Generation for Dynamic-Multithreading Platforms", |
92 |
< |
* PPoPP 2012, but improves and extends it in several ways. |
93 |
< |
* |
94 |
< |
* The primary update step (see method nextSeed()) is simply to |
95 |
< |
* add a constant ("gamma") to the current seed, modulo a prime |
96 |
< |
* ("George"). However, the nextLong and nextInt methods do not |
97 |
< |
* return this value, but instead the results of bit-mixing |
98 |
< |
* transformations that produce more uniformly distributed |
99 |
< |
* sequences. |
100 |
< |
* |
101 |
< |
* "George" is the otherwise nameless (because it cannot be |
102 |
< |
* represented) prime number 2^64+13. Using a prime number larger |
103 |
< |
* than can fit in a long ensures that all possible long values |
104 |
< |
* can occur, plus 13 others that just get skipped over when they |
105 |
< |
* are encountered; see method addGammaModGeorge. For this to |
106 |
< |
* work, initial gamma values must be at least 13. |
112 |
< |
* |
113 |
< |
* The value of gamma differs for each instance across a series of |
114 |
< |
* splits, and is generated using a slightly stripped-down variant |
115 |
< |
* of the same algorithm, but operating across calls to split(), |
116 |
< |
* not calls to nextSeed(): Each instance carries the state of |
117 |
< |
* this generator as nextSplit, and uses mix64(nextSplit) as its |
118 |
< |
* own gamma value. Computations of gammas themselves use a fixed |
119 |
< |
* constant as the second argument to the addGammaModGeorge |
120 |
< |
* function, GAMMA_GAMMA, a "genuinely random" number from a |
121 |
< |
* radioactive decay reading (obtained from |
122 |
< |
* http://www.fourmilab.ch/hotbits/) meeting the above range |
123 |
< |
* constraint. Using a fixed constant maintains the invariant that |
124 |
< |
* the value of gamma is the same for every instance that is at |
125 |
< |
* the same split-distance from their common root. (Note: there is |
126 |
< |
* nothing especially magic about obtaining this constant from a |
127 |
< |
* "truly random" physical source rather than just choosing one |
128 |
< |
* arbitrarily; using "hotbits" was merely an aesthetically pleasing |
129 |
< |
* choice. In either case, good statistical behavior of the |
130 |
< |
* algorithm should be, and was, verified by using the DieHarder |
131 |
< |
* test suite.) |
132 |
< |
* |
133 |
< |
* The mix64 bit-mixing function called by nextLong and other |
134 |
< |
* methods computes the same value as the "64-bit finalizer" |
135 |
< |
* function in Austin Appleby's MurmurHash3 algorithm. See |
92 |
> |
* PPoPP 2012, as well as those in "Parallel random numbers: as |
93 |
> |
* easy as 1, 2, 3" by Salmon, Morae, Dror, and Shaw, SC 2011. It |
94 |
> |
* differs mainly in simplifying and cheapening operations. |
95 |
> |
* |
96 |
> |
* The primary update step (method nextSeed()) is to add a |
97 |
> |
* constant ("gamma") to the current (64 bit) seed, forming a |
98 |
> |
* simple sequence. The seed and the gamma values for any two |
99 |
> |
* SplittableRandom instances are highly likely to be different. |
100 |
> |
* |
101 |
> |
* Methods nextLong, nextInt, and derivatives do not return the |
102 |
> |
* sequence (seed) values, but instead a hash-like bit-mix of |
103 |
> |
* their bits, producing more independently distributed sequences. |
104 |
> |
* For nextLong, the mix64 bit-mixing function computes the same |
105 |
> |
* value as the "64-bit finalizer" function in Austin Appleby's |
106 |
> |
* MurmurHash3 algorithm. See |
107 |
|
* http://code.google.com/p/smhasher/wiki/MurmurHash3 , which |
108 |
|
* comments: "The constants for the finalizers were generated by a |
109 |
|
* simple simulated-annealing algorithm, and both avalanche all |
110 |
< |
* bits of 'h' to within 0.25% bias." It also appears to work to |
111 |
< |
* use instead any of the variants proposed by David Stafford at |
112 |
< |
* http://zimbry.blogspot.com/2011/09/better-bit-mixing-improving-on.html |
113 |
< |
* but these variants have not yet been tested as thoroughly |
114 |
< |
* in the context of the implementation of SplittableRandom. |
115 |
< |
* |
116 |
< |
* The mix32 function used for nextInt just consists of two of the |
117 |
< |
* five lines of mix64; avalanche testing shows that the 64-bit result |
118 |
< |
* has its top 32 bits avalanched well, though not the bottom 32 bits. |
119 |
< |
* DieHarder tests show that it is adequate for generating one |
120 |
< |
* random int from the 64-bit result of nextSeed. |
121 |
< |
* |
122 |
< |
* Support for the default (no-argument) constructor relies on an |
123 |
< |
* AtomicLong (defaultSeedGenerator) to help perform the |
124 |
< |
* equivalent of a split of a statically constructed |
125 |
< |
* SplittableRandom. Unlike other cases, this split must be |
126 |
< |
* performed in a thread-safe manner. We use |
127 |
< |
* AtomicLong.compareAndSet as the (typically) most efficient |
128 |
< |
* mechanism. To bootstrap, we start off using System.nanotime(), |
129 |
< |
* and update using another "genuinely random" constant |
130 |
< |
* DEFAULT_SEED_GAMMA. The default constructor uses GAMMA_GAMMA, |
131 |
< |
* not 0, for its splitSeed argument (addGammaModGeorge(0, |
132 |
< |
* GAMMA_GAMMA) == GAMMA_GAMMA) to reflect that each is split from |
133 |
< |
* this root generator, even though the root is not explicitly |
134 |
< |
* represented as a SplittableRandom. |
110 |
> |
* 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. |
113 |
> |
* |
114 |
> |
* The split operation uses the current generator to form the seed |
115 |
> |
* and gamma for another SplittableRandom. To conservatively |
116 |
> |
* avoid potential correlations between seed and value generation, |
117 |
> |
* gamma selection (method nextGamma) uses the "Mix13" constants |
118 |
> |
* for MurmurHash3 described by David Stafford |
119 |
> |
* (http://zimbry.blogspot.com/2011/09/better-bit-mixing-improving-on.html) |
120 |
> |
* To avoid potential weaknesses in bit-mixing transformations, we |
121 |
> |
* restrict gammas to odd values with at least 12 and no more than |
122 |
> |
* 52 bits set. Rather than rejecting candidates with too few or |
123 |
> |
* too many bits set, method nextGamma flips some bits (which has |
124 |
> |
* 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 |
127 |
> |
* automated screening for sequence constant selection that is |
128 |
> |
* left as an empirical decision in some other hashing and crypto |
129 |
> |
* algorithms. |
130 |
> |
* |
131 |
> |
* The resulting generator thus transforms a sequence in which |
132 |
> |
* (typically) many bits change on each step, with an inexpensive |
133 |
> |
* mixer with good (but less than cryptographically secure) |
134 |
> |
* avalanching. |
135 |
> |
* |
136 |
> |
* The default (no-argument) constructor, in essence, invokes |
137 |
> |
* split() for a common "seeder" SplittableRandom. Unlike other |
138 |
> |
* cases, this split must be performed in a thread-safe manner, so |
139 |
> |
* we use an AtomicLong to represent the seed rather than use an |
140 |
> |
* explicit SplittableRandom. To bootstrap the seeder, we start |
141 |
> |
* off using a seed based on current time and host. This serves as |
142 |
> |
* a slimmed-down (and insecure) variant of SecureRandom that also |
143 |
> |
* avoids stalls that may occur when using /dev/random. |
144 |
> |
* |
145 |
> |
* It is a relatively simple matter to apply the basic design here |
146 |
> |
* to use 128 bit seeds. However, emulating 128bit arithmetic and |
147 |
> |
* carrying around twice the state add more overhead than appears |
148 |
> |
* warranted for current usages. |
149 |
> |
* |
150 |
> |
* File organization: First the non-public methods that constitute |
151 |
> |
* the main algorithm, then the main public methods, followed by |
152 |
> |
* some custom spliterator classes needed for stream methods. |
153 |
|
*/ |
154 |
|
|
155 |
|
/** |
156 |
< |
* The "genuinely random" value for producing new gamma values. |
157 |
< |
* The value is arbitrary, subject to the requirement that it be |
158 |
< |
* greater or equal to 13. |
170 |
< |
*/ |
171 |
< |
private static final long GAMMA_GAMMA = 0xF2281E2DBA6606F3L; |
172 |
< |
|
173 |
< |
/** |
174 |
< |
* The "genuinely random" seed update value for default constructors. |
175 |
< |
* The value is arbitrary, subject to the requirement that it be |
176 |
< |
* greater or equal to 13. |
156 |
> |
* The initial gamma value for (unsplit) SplittableRandoms. Must |
157 |
> |
* be odd with at least 12 and no more than 52 bits set. Currently |
158 |
> |
* set to the golden ratio scaled to 64bits. |
159 |
|
*/ |
160 |
< |
private static final long DEFAULT_SEED_GAMMA = 0xBD24B73A95FB84D9L; |
160 |
> |
private static final long INITIAL_GAMMA = 0x9e3779b97f4a7c15L; |
161 |
|
|
162 |
|
/** |
163 |
|
* The least non-zero value returned by nextDouble(). This value |
166 |
|
private static final double DOUBLE_UNIT = 1.0 / (1L << 53); |
167 |
|
|
168 |
|
/** |
169 |
< |
* The next seed for default constructors. |
188 |
< |
*/ |
189 |
< |
private static final AtomicLong defaultSeedGenerator = |
190 |
< |
new AtomicLong(System.nanoTime()); |
191 |
< |
|
192 |
< |
/** |
193 |
< |
* The seed, updated only via method nextSeed. |
169 |
> |
* The seed. Updated only via method nextSeed. |
170 |
|
*/ |
171 |
|
private long seed; |
172 |
|
|
173 |
|
/** |
174 |
< |
* The constant value added to seed (mod George) on each update. |
174 |
> |
* The step value. |
175 |
|
*/ |
176 |
|
private final long gamma; |
177 |
|
|
178 |
|
/** |
179 |
< |
* The next seed to use for splits. Propagated using |
204 |
< |
* addGammaModGeorge across instances. |
205 |
< |
*/ |
206 |
< |
private final long nextSplit; |
207 |
< |
|
208 |
< |
/** |
209 |
< |
* Adds the given gamma value, g, to the given seed value s, mod |
210 |
< |
* George (2^64+13). We regard s and g as unsigned values |
211 |
< |
* (ranging from 0 to 2^64-1). We add g to s either once or twice |
212 |
< |
* (mod George) as necessary to produce an (unsigned) result less |
213 |
< |
* than 2^64. We require that g must be at least 13. This |
214 |
< |
* guarantees that if (s+g) mod George >= 2^64 then (s+g+g) mod |
215 |
< |
* George < 2^64; thus we need only a conditional, not a loop, |
216 |
< |
* to be sure of getting a representable value. |
217 |
< |
* |
218 |
< |
* @param s a seed value |
219 |
< |
* @param g a gamma value, 13 <= g (as unsigned) |
179 |
> |
* Internal constructor used by all others except default constructor. |
180 |
|
*/ |
181 |
< |
private static long addGammaModGeorge(long s, long g) { |
182 |
< |
long p = s + g; |
183 |
< |
if (Long.compareUnsigned(p, g) >= 0) |
224 |
< |
return p; |
225 |
< |
long q = p - 13L; |
226 |
< |
return (Long.compareUnsigned(p, 13L) >= 0) ? q : (q + g); |
181 |
> |
private SplittableRandom(long seed, long gamma) { |
182 |
> |
this.seed = seed; |
183 |
> |
this.gamma = gamma; |
184 |
|
} |
185 |
|
|
186 |
|
/** |
187 |
< |
* Returns a bit-mixed transformation of its argument. |
231 |
< |
* See above for explanation. |
187 |
> |
* Computes MurmurHash3 64bit mix function. |
188 |
|
*/ |
189 |
|
private static long mix64(long z) { |
190 |
< |
z ^= (z >>> 33); |
191 |
< |
z *= 0xff51afd7ed558ccdL; |
192 |
< |
z ^= (z >>> 33); |
237 |
< |
z *= 0xc4ceb9fe1a85ec53L; |
238 |
< |
z ^= (z >>> 33); |
239 |
< |
return z; |
190 |
> |
z = (z ^ (z >>> 33)) * 0xff51afd7ed558ccdL; |
191 |
> |
z = (z ^ (z >>> 33)) * 0xc4ceb9fe1a85ec53L; |
192 |
> |
return z ^ (z >>> 33); |
193 |
|
} |
194 |
|
|
195 |
|
/** |
196 |
< |
* Returns a bit-mixed int transformation of its argument. |
244 |
< |
* See above for explanation. |
196 |
> |
* Returns the 32 high bits of mix64(z) as int. |
197 |
|
*/ |
198 |
|
private static int mix32(long z) { |
199 |
< |
z ^= (z >>> 33); |
200 |
< |
z *= 0xc4ceb9fe1a85ec53L; |
249 |
< |
return (int)(z >>> 32); |
199 |
> |
z = (z ^ (z >>> 33)) * 0xff51afd7ed558ccdL; |
200 |
> |
return (int)(((z ^ (z >>> 33)) * 0xc4ceb9fe1a85ec53L) >>> 32); |
201 |
|
} |
202 |
|
|
203 |
|
/** |
204 |
< |
* Internal constructor used by all other constructors and by |
254 |
< |
* method split. Establishes the initial seed for this instance, |
255 |
< |
* and uses the given splitSeed to establish gamma, as well as the |
256 |
< |
* nextSplit to use by this instance. The loop to skip ineligible |
257 |
< |
* gammas very rarely iterates, and does so at most 13 times. |
204 |
> |
* Returns the gamma value to use for a new split instance. |
205 |
|
*/ |
206 |
< |
private SplittableRandom(long seed, long splitSeed) { |
207 |
< |
this.seed = seed; |
208 |
< |
long s = splitSeed, g; |
209 |
< |
do { // ensure gamma >= 13, considered as an unsigned integer |
210 |
< |
s = addGammaModGeorge(s, GAMMA_GAMMA); |
211 |
< |
g = mix64(s); |
265 |
< |
} while (Long.compareUnsigned(g, 13L) < 0); |
266 |
< |
this.gamma = g; |
267 |
< |
this.nextSplit = s; |
206 |
> |
private static long nextGamma(long z) { |
207 |
> |
z = (z ^ (z >>> 30)) * 0xbf58476d1ce4e5b9L; // Stafford "Mix13" |
208 |
> |
z = (z ^ (z >>> 27)) * 0x94d049bb133111ebL; |
209 |
> |
z = (z ^ (z >>> 31)) | 1L; // force to be odd |
210 |
> |
int n = Long.bitCount(z); // ensure enough 0 and 1 bits |
211 |
> |
return (n < 12 || n > 52) ? z ^ 0xaaaaaaaaaaaaaaaaL : z; |
212 |
|
} |
213 |
|
|
214 |
|
/** |
215 |
< |
* Updates in-place and returns seed. |
272 |
< |
* See above for explanation. |
215 |
> |
* Adds gamma to seed. |
216 |
|
*/ |
217 |
|
private long nextSeed() { |
218 |
< |
return seed = addGammaModGeorge(seed, gamma); |
218 |
> |
return seed += gamma; |
219 |
|
} |
220 |
|
|
221 |
|
/** |
222 |
< |
* Atomically updates and returns next seed for default constructor. |
222 |
> |
* The seed generator for default constructors. |
223 |
> |
*/ |
224 |
> |
private static final AtomicLong seeder = |
225 |
> |
new AtomicLong(mix64((((long)hashedHostAddress()) << 32) ^ |
226 |
> |
System.currentTimeMillis()) ^ |
227 |
> |
mix64(System.nanoTime())); |
228 |
> |
|
229 |
> |
/** |
230 |
> |
* Returns hash of local host IP address, if available; else 0. |
231 |
|
*/ |
232 |
< |
private static long nextDefaultSeed() { |
233 |
< |
long oldSeed, newSeed; |
234 |
< |
do { |
235 |
< |
oldSeed = defaultSeedGenerator.get(); |
236 |
< |
newSeed = addGammaModGeorge(oldSeed, DEFAULT_SEED_GAMMA); |
237 |
< |
} while (!defaultSeedGenerator.compareAndSet(oldSeed, newSeed)); |
287 |
< |
return mix64(newSeed); |
232 |
> |
private static int hashedHostAddress() { |
233 |
> |
try { |
234 |
> |
return InetAddress.getLocalHost().hashCode(); |
235 |
> |
} catch (Exception ex) { |
236 |
> |
return 0; |
237 |
> |
} |
238 |
|
} |
239 |
|
|
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 |
+ |
|
245 |
|
/* |
246 |
|
* Internal versions of nextX methods used by streams, as well as |
247 |
|
* the public nextX(origin, bound) methods. These exist mainly to |
317 |
|
int r = mix32(nextSeed()); |
318 |
|
if (origin < bound) { |
319 |
|
int n = bound - origin, m = n - 1; |
320 |
< |
if ((n & m) == 0L) |
320 |
> |
if ((n & m) == 0) |
321 |
|
r = (r & m) + origin; |
322 |
|
else if (n > 0) { |
323 |
|
for (int u = r >>> 1; |
356 |
|
/** |
357 |
|
* Creates a new SplittableRandom instance using the specified |
358 |
|
* initial seed. SplittableRandom instances created with the same |
359 |
< |
* seed generate identical sequences of values. |
359 |
> |
* seed in the same program generate identical sequences of values. |
360 |
|
* |
361 |
|
* @param seed the initial seed |
362 |
|
*/ |
363 |
|
public SplittableRandom(long seed) { |
364 |
< |
this(seed, 0); |
364 |
> |
this(seed, INITIAL_GAMMA); |
365 |
|
} |
366 |
|
|
367 |
|
/** |
370 |
|
* of those of any other instances in the current program; and |
371 |
|
* may, and typically does, vary across program invocations. |
372 |
|
*/ |
373 |
< |
public SplittableRandom() { |
374 |
< |
this(nextDefaultSeed(), GAMMA_GAMMA); |
373 |
> |
public SplittableRandom() { // emulate seeder.split() |
374 |
> |
this.gamma = nextGamma(this.seed = seeder.addAndGet(INITIAL_GAMMA)); |
375 |
|
} |
376 |
|
|
377 |
|
/** |
389 |
|
* @return the new SplittableRandom instance |
390 |
|
*/ |
391 |
|
public SplittableRandom split() { |
392 |
< |
return new SplittableRandom(nextSeed(), nextSplit); |
392 |
> |
long s = nextSeed(); |
393 |
> |
return new SplittableRandom(s, nextGamma(s)); |
394 |
|
} |
395 |
|
|
396 |
|
/** |
409 |
|
* @param bound the bound on the random number to be returned. Must be |
410 |
|
* positive. |
411 |
|
* @return a pseudorandom {@code int} value between zero |
412 |
< |
* (inclusive) and the bound (exclusive). |
413 |
< |
* @throws IllegalArgumentException if the bound is less than zero |
412 |
> |
* (inclusive) and the bound (exclusive) |
413 |
> |
* @throws IllegalArgumentException if {@code bound} is not positive |
414 |
|
*/ |
415 |
|
public int nextInt(int bound) { |
416 |
|
if (bound <= 0) |
417 |
< |
throw new IllegalArgumentException("bound must be positive"); |
417 |
> |
throw new IllegalArgumentException(BadBound); |
418 |
|
// Specialize internalNextInt for origin 0 |
419 |
|
int r = mix32(nextSeed()); |
420 |
|
int m = bound - 1; |
421 |
< |
if ((bound & m) == 0L) // power of two |
421 |
> |
if ((bound & m) == 0) // power of two |
422 |
|
r &= m; |
423 |
|
else { // reject over-represented candidates |
424 |
|
for (int u = r >>> 1; |
436 |
|
* @param origin the least value returned |
437 |
|
* @param bound the upper bound (exclusive) |
438 |
|
* @return a pseudorandom {@code int} value between the origin |
439 |
< |
* (inclusive) and the bound (exclusive). |
439 |
> |
* (inclusive) and the bound (exclusive) |
440 |
|
* @throws IllegalArgumentException if {@code origin} is greater than |
441 |
|
* or equal to {@code bound} |
442 |
|
*/ |
443 |
|
public int nextInt(int origin, int bound) { |
444 |
|
if (origin >= bound) |
445 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
445 |
> |
throw new IllegalArgumentException(BadRange); |
446 |
|
return internalNextInt(origin, bound); |
447 |
|
} |
448 |
|
|
462 |
|
* @param bound the bound on the random number to be returned. Must be |
463 |
|
* 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 |
465 |
> |
* (inclusive) and the bound (exclusive) |
466 |
> |
* @throws IllegalArgumentException if {@code bound} is not positive |
467 |
|
*/ |
468 |
|
public long nextLong(long bound) { |
469 |
|
if (bound <= 0) |
470 |
< |
throw new IllegalArgumentException("bound must be positive"); |
470 |
> |
throw new IllegalArgumentException(BadBound); |
471 |
|
// Specialize internalNextLong for origin 0 |
472 |
|
long r = mix64(nextSeed()); |
473 |
|
long m = bound - 1; |
489 |
|
* @param origin the least value returned |
490 |
|
* @param bound the upper bound (exclusive) |
491 |
|
* @return a pseudorandom {@code long} value between the origin |
492 |
< |
* (inclusive) and the bound (exclusive). |
492 |
> |
* (inclusive) and the bound (exclusive) |
493 |
|
* @throws IllegalArgumentException if {@code origin} is greater than |
494 |
|
* or equal to {@code bound} |
495 |
|
*/ |
496 |
|
public long nextLong(long origin, long bound) { |
497 |
|
if (origin >= bound) |
498 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
498 |
> |
throw new IllegalArgumentException(BadRange); |
499 |
|
return internalNextLong(origin, bound); |
500 |
|
} |
501 |
|
|
507 |
|
* (inclusive) and one (exclusive) |
508 |
|
*/ |
509 |
|
public double nextDouble() { |
510 |
< |
return (nextLong() >>> 11) * DOUBLE_UNIT; |
510 |
> |
return (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT; |
511 |
|
} |
512 |
|
|
513 |
|
/** |
517 |
|
* @param bound the bound on the random number to be returned. Must be |
518 |
|
* positive. |
519 |
|
* @return a pseudorandom {@code double} value between zero |
520 |
< |
* (inclusive) and the bound (exclusive). |
521 |
< |
* @throws IllegalArgumentException if {@code bound} is less than zero |
520 |
> |
* (inclusive) and the bound (exclusive) |
521 |
> |
* @throws IllegalArgumentException if {@code bound} is not positive |
522 |
|
*/ |
523 |
|
public double nextDouble(double bound) { |
524 |
|
if (!(bound > 0.0)) |
525 |
< |
throw new IllegalArgumentException("bound must be positive"); |
526 |
< |
double result = nextDouble() * bound; |
525 |
> |
throw new IllegalArgumentException(BadBound); |
526 |
> |
double result = (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT * bound; |
527 |
|
return (result < bound) ? result : // correct for rounding |
528 |
|
Double.longBitsToDouble(Double.doubleToLongBits(bound) - 1); |
529 |
|
} |
535 |
|
* @param origin the least value returned |
536 |
|
* @param bound the upper bound |
537 |
|
* @return a pseudorandom {@code double} value between the origin |
538 |
< |
* (inclusive) and the bound (exclusive). |
538 |
> |
* (inclusive) and the bound (exclusive) |
539 |
|
* @throws IllegalArgumentException if {@code origin} is greater than |
540 |
|
* or equal to {@code bound} |
541 |
|
*/ |
542 |
|
public double nextDouble(double origin, double bound) { |
543 |
|
if (!(origin < bound)) |
544 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
544 |
> |
throw new IllegalArgumentException(BadRange); |
545 |
|
return internalNextDouble(origin, bound); |
546 |
|
} |
547 |
|
|
548 |
+ |
/** |
549 |
+ |
* Returns a pseudorandom {@code boolean} value. |
550 |
+ |
* |
551 |
+ |
* @return a pseudorandom {@code boolean} value |
552 |
+ |
*/ |
553 |
+ |
public boolean nextBoolean() { |
554 |
+ |
return mix32(nextSeed()) < 0; |
555 |
+ |
} |
556 |
+ |
|
557 |
|
// stream methods, coded in a way intended to better isolate for |
558 |
|
// maintenance purposes the small differences across forms. |
559 |
|
|
560 |
|
/** |
561 |
< |
* Returns a stream producing the given {@code streamSize} number of |
562 |
< |
* pseudorandom {@code int} values. |
561 |
> |
* Returns a stream producing the given {@code streamSize} number |
562 |
> |
* of pseudorandom {@code int} values from this generator and/or |
563 |
> |
* one split from it. |
564 |
|
* |
565 |
|
* @param streamSize the number of values to generate |
566 |
|
* @return a stream of pseudorandom {@code int} values |
569 |
|
*/ |
570 |
|
public IntStream ints(long streamSize) { |
571 |
|
if (streamSize < 0L) |
572 |
< |
throw new IllegalArgumentException("negative Stream size"); |
572 |
> |
throw new IllegalArgumentException(BadSize); |
573 |
|
return StreamSupport.intStream |
574 |
|
(new RandomIntsSpliterator |
575 |
|
(this, 0L, streamSize, Integer.MAX_VALUE, 0), |
578 |
|
|
579 |
|
/** |
580 |
|
* Returns an effectively unlimited stream of pseudorandom {@code int} |
581 |
< |
* values |
581 |
> |
* values from this generator and/or one split from it. |
582 |
|
* |
583 |
|
* @implNote This method is implemented to be equivalent to {@code |
584 |
|
* ints(Long.MAX_VALUE)}. |
593 |
|
} |
594 |
|
|
595 |
|
/** |
596 |
< |
* Returns a stream producing the given {@code streamSize} number of |
597 |
< |
* pseudorandom {@code int} values, each conforming to the given |
598 |
< |
* origin and bound. |
596 |
> |
* Returns a stream producing the given {@code streamSize} number |
597 |
> |
* of pseudorandom {@code int} values, each conforming to the |
598 |
> |
* given origin and bound. |
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 |
603 |
|
* @return a stream of pseudorandom {@code int} values, |
604 |
< |
* each with the given origin and bound. |
604 |
> |
* each with the given origin and bound |
605 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
606 |
|
* less than zero, or {@code randomNumberOrigin} |
607 |
|
* is greater than or equal to {@code randomNumberBound} |
609 |
|
public IntStream ints(long streamSize, int randomNumberOrigin, |
610 |
|
int randomNumberBound) { |
611 |
|
if (streamSize < 0L) |
612 |
< |
throw new IllegalArgumentException("negative Stream size"); |
612 |
> |
throw new IllegalArgumentException(BadSize); |
613 |
|
if (randomNumberOrigin >= randomNumberBound) |
614 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
614 |
> |
throw new IllegalArgumentException(BadRange); |
615 |
|
return StreamSupport.intStream |
616 |
|
(new RandomIntsSpliterator |
617 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
628 |
|
* @param randomNumberOrigin the origin of each random value |
629 |
|
* @param randomNumberBound the bound of each random value |
630 |
|
* @return a stream of pseudorandom {@code int} values, |
631 |
< |
* each with the given origin and bound. |
631 |
> |
* each with the given origin and bound |
632 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
633 |
|
* is greater than or equal to {@code randomNumberBound} |
634 |
|
*/ |
635 |
|
public IntStream ints(int randomNumberOrigin, int randomNumberBound) { |
636 |
|
if (randomNumberOrigin >= randomNumberBound) |
637 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
637 |
> |
throw new IllegalArgumentException(BadRange); |
638 |
|
return StreamSupport.intStream |
639 |
|
(new RandomIntsSpliterator |
640 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
642 |
|
} |
643 |
|
|
644 |
|
/** |
645 |
< |
* Returns a stream producing the given {@code streamSize} number of |
646 |
< |
* pseudorandom {@code long} values. |
645 |
> |
* Returns a stream producing the given {@code streamSize} number |
646 |
> |
* of pseudorandom {@code long} values from this generator and/or |
647 |
> |
* one split from it. |
648 |
|
* |
649 |
|
* @param streamSize the number of values to generate |
650 |
|
* @return a stream of pseudorandom {@code long} values |
653 |
|
*/ |
654 |
|
public LongStream longs(long streamSize) { |
655 |
|
if (streamSize < 0L) |
656 |
< |
throw new IllegalArgumentException("negative Stream size"); |
656 |
> |
throw new IllegalArgumentException(BadSize); |
657 |
|
return StreamSupport.longStream |
658 |
|
(new RandomLongsSpliterator |
659 |
|
(this, 0L, streamSize, Long.MAX_VALUE, 0L), |
661 |
|
} |
662 |
|
|
663 |
|
/** |
664 |
< |
* Returns an effectively unlimited stream of pseudorandom {@code long} |
665 |
< |
* values. |
664 |
> |
* Returns an effectively unlimited stream of pseudorandom {@code |
665 |
> |
* long} values from this generator and/or one split from it. |
666 |
|
* |
667 |
|
* @implNote This method is implemented to be equivalent to {@code |
668 |
|
* longs(Long.MAX_VALUE)}. |
685 |
|
* @param randomNumberOrigin the origin of each random value |
686 |
|
* @param randomNumberBound the bound of each random value |
687 |
|
* @return a stream of pseudorandom {@code long} values, |
688 |
< |
* each with the given origin and bound. |
688 |
> |
* each with the given origin and bound |
689 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
690 |
|
* less than zero, or {@code randomNumberOrigin} |
691 |
|
* is greater than or equal to {@code randomNumberBound} |
693 |
|
public LongStream longs(long streamSize, long randomNumberOrigin, |
694 |
|
long randomNumberBound) { |
695 |
|
if (streamSize < 0L) |
696 |
< |
throw new IllegalArgumentException("negative Stream size"); |
696 |
> |
throw new IllegalArgumentException(BadSize); |
697 |
|
if (randomNumberOrigin >= randomNumberBound) |
698 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
698 |
> |
throw new IllegalArgumentException(BadRange); |
699 |
|
return StreamSupport.longStream |
700 |
|
(new RandomLongsSpliterator |
701 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
712 |
|
* @param randomNumberOrigin the origin of each random value |
713 |
|
* @param randomNumberBound the bound of each random value |
714 |
|
* @return a stream of pseudorandom {@code long} values, |
715 |
< |
* each with the given origin and bound. |
715 |
> |
* each with the given origin and bound |
716 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
717 |
|
* is greater than or equal to {@code randomNumberBound} |
718 |
|
*/ |
719 |
|
public LongStream longs(long randomNumberOrigin, long randomNumberBound) { |
720 |
|
if (randomNumberOrigin >= randomNumberBound) |
721 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
721 |
> |
throw new IllegalArgumentException(BadRange); |
722 |
|
return StreamSupport.longStream |
723 |
|
(new RandomLongsSpliterator |
724 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
737 |
|
*/ |
738 |
|
public DoubleStream doubles(long streamSize) { |
739 |
|
if (streamSize < 0L) |
740 |
< |
throw new IllegalArgumentException("negative Stream size"); |
740 |
> |
throw new IllegalArgumentException(BadSize); |
741 |
|
return StreamSupport.doubleStream |
742 |
|
(new RandomDoublesSpliterator |
743 |
|
(this, 0L, streamSize, Double.MAX_VALUE, 0.0), |
770 |
|
* @param randomNumberOrigin the origin of each random value |
771 |
|
* @param randomNumberBound the bound of each random value |
772 |
|
* @return a stream of pseudorandom {@code double} values, |
773 |
< |
* each with the given origin and bound. |
773 |
> |
* each with the given origin and bound |
774 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
775 |
< |
* less than zero. |
775 |
> |
* less than zero |
776 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
777 |
|
* is greater than or equal to {@code randomNumberBound} |
778 |
|
*/ |
779 |
|
public DoubleStream doubles(long streamSize, double randomNumberOrigin, |
780 |
|
double randomNumberBound) { |
781 |
|
if (streamSize < 0L) |
782 |
< |
throw new IllegalArgumentException("negative Stream size"); |
782 |
> |
throw new IllegalArgumentException(BadSize); |
783 |
|
if (!(randomNumberOrigin < randomNumberBound)) |
784 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
784 |
> |
throw new IllegalArgumentException(BadRange); |
785 |
|
return StreamSupport.doubleStream |
786 |
|
(new RandomDoublesSpliterator |
787 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
798 |
|
* @param randomNumberOrigin the origin of each random value |
799 |
|
* @param randomNumberBound the bound of each random value |
800 |
|
* @return a stream of pseudorandom {@code double} values, |
801 |
< |
* each with the given origin and bound. |
801 |
> |
* each with the given origin and bound |
802 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
803 |
|
* is greater than or equal to {@code randomNumberBound} |
804 |
|
*/ |
805 |
|
public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) { |
806 |
|
if (!(randomNumberOrigin < randomNumberBound)) |
807 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
807 |
> |
throw new IllegalArgumentException(BadRange); |
808 |
|
return StreamSupport.doubleStream |
809 |
|
(new RandomDoublesSpliterator |
810 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
819 |
|
* approach. The long and double versions of this class are |
820 |
|
* identical except for types. |
821 |
|
*/ |
822 |
< |
static class RandomIntsSpliterator implements Spliterator.OfInt { |
822 |
> |
static final class RandomIntsSpliterator implements Spliterator.OfInt { |
823 |
|
final SplittableRandom rng; |
824 |
|
long index; |
825 |
|
final long fence; |
862 |
|
long i = index, f = fence; |
863 |
|
if (i < f) { |
864 |
|
index = f; |
865 |
+ |
SplittableRandom r = rng; |
866 |
|
int o = origin, b = bound; |
867 |
|
do { |
868 |
< |
consumer.accept(rng.internalNextInt(o, b)); |
868 |
> |
consumer.accept(r.internalNextInt(o, b)); |
869 |
|
} while (++i < f); |
870 |
|
} |
871 |
|
} |
874 |
|
/** |
875 |
|
* Spliterator for long streams. |
876 |
|
*/ |
877 |
< |
static class RandomLongsSpliterator implements Spliterator.OfLong { |
877 |
> |
static final class RandomLongsSpliterator implements Spliterator.OfLong { |
878 |
|
final SplittableRandom rng; |
879 |
|
long index; |
880 |
|
final long fence; |
917 |
|
long i = index, f = fence; |
918 |
|
if (i < f) { |
919 |
|
index = f; |
920 |
+ |
SplittableRandom r = rng; |
921 |
|
long o = origin, b = bound; |
922 |
|
do { |
923 |
< |
consumer.accept(rng.internalNextLong(o, b)); |
923 |
> |
consumer.accept(r.internalNextLong(o, b)); |
924 |
|
} while (++i < f); |
925 |
|
} |
926 |
|
} |
930 |
|
/** |
931 |
|
* Spliterator for double streams. |
932 |
|
*/ |
933 |
< |
static class RandomDoublesSpliterator implements Spliterator.OfDouble { |
933 |
> |
static final class RandomDoublesSpliterator implements Spliterator.OfDouble { |
934 |
|
final SplittableRandom rng; |
935 |
|
long index; |
936 |
|
final long fence; |
973 |
|
long i = index, f = fence; |
974 |
|
if (i < f) { |
975 |
|
index = f; |
976 |
+ |
SplittableRandom r = rng; |
977 |
|
double o = origin, b = bound; |
978 |
|
do { |
979 |
< |
consumer.accept(rng.internalNextDouble(o, b)); |
979 |
> |
consumer.accept(r.internalNextDouble(o, b)); |
980 |
|
} while (++i < f); |
981 |
|
} |
982 |
|
} |
983 |
|
} |
984 |
|
|
985 |
|
} |
1016 |
– |
|