26 |
|
package java.util; |
27 |
|
|
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; |
33 |
< |
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: |
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 |
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 { |
84 |
< |
|
85 |
< |
/* |
86 |
< |
* File organization: First the non-public methods that constitute |
87 |
< |
* the main algorithm, then the main public methods, followed by |
88 |
< |
* some custom spliterator classes needed for stream methods. |
89 |
< |
* |
90 |
< |
* Credits: Primary algorithm and code by Guy Steele. Stream |
91 |
< |
* support methods by Doug Lea. Documentation jointly produced |
92 |
< |
* with additional help from Brian Goetz. |
93 |
< |
*/ |
89 |
> |
public final class SplittableRandom { |
90 |
|
|
91 |
|
/* |
92 |
|
* Implementation Overview. |
94 |
|
* This algorithm was inspired by the "DotMix" algorithm by |
95 |
|
* Leiserson, Schardl, and Sukha "Deterministic Parallel |
96 |
|
* Random-Number Generation for Dynamic-Multithreading Platforms", |
97 |
< |
* PPoPP 2012, but improves and extends it in several ways. |
97 |
> |
* PPoPP 2012, as well as those in "Parallel random numbers: as |
98 |
> |
* easy as 1, 2, 3" by Salmon, Morae, Dror, and Shaw, SC 2011. It |
99 |
> |
* differs mainly in simplifying and cheapening operations. |
100 |
> |
* |
101 |
> |
* The primary update step (method nextSeed()) is to add a |
102 |
> |
* constant ("gamma") to the current (64 bit) seed, forming a |
103 |
> |
* simple sequence. The seed and the gamma values for any two |
104 |
> |
* SplittableRandom instances are highly likely to be different. |
105 |
> |
* |
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 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 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. |
131 |
> |
* |
132 |
> |
* The resulting generator thus transforms a sequence in which |
133 |
> |
* (typically) many bits change on each step, with an inexpensive |
134 |
> |
* mixer with good (but less than cryptographically secure) |
135 |
> |
* avalanching. |
136 |
> |
* |
137 |
> |
* The default (no-argument) constructor, in essence, invokes |
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 |
149 |
> |
* carrying around twice the state add more overhead than appears |
150 |
> |
* warranted for current usages. |
151 |
|
* |
152 |
< |
* The primary update step (see method nextSeed()) is simply to |
153 |
< |
* add a constant ("gamma") to the current seed, modulo a prime |
154 |
< |
* ("George"). However, the nextLong and nextInt methods do not |
106 |
< |
* return this value, but instead the results of bit-mixing |
107 |
< |
* transformations that produce more uniformly distributed |
108 |
< |
* sequences. |
109 |
< |
* |
110 |
< |
* "George" is the otherwise nameless (because it cannot be |
111 |
< |
* represented) prime number 2^64+13. Using a prime number larger |
112 |
< |
* than can fit in a long ensures that all possible long values |
113 |
< |
* can occur, plus 13 others that just get skipped over when they |
114 |
< |
* are encountered; see method addGammaModGeorge. For this to |
115 |
< |
* work, initial gamma values must be at least 13. |
116 |
< |
* |
117 |
< |
* The value of gamma differs for each instance across a series of |
118 |
< |
* splits, and is generated using a slightly stripped-down variant |
119 |
< |
* of the same algorithm, but operating across calls to split(), |
120 |
< |
* not calls to nextSeed(): Each instance carries the state of |
121 |
< |
* this generator as nextSplit, and uses mix64(nextSplit) as its |
122 |
< |
* own gamma value. Computations of gammas themselves use a fixed |
123 |
< |
* constant as the second argument to the addGammaModGeorge |
124 |
< |
* function, GAMMA_GAMMA, a "genuinely random" number from a |
125 |
< |
* radioactive decay reading (obtained from |
126 |
< |
* http://www.fourmilab.ch/hotbits/) meeting the above range |
127 |
< |
* constraint. Using a fixed constant maintains the invariant that |
128 |
< |
* the value of gamma is the same for every instance that is at |
129 |
< |
* the same split-distance from their common root. (Note: there is |
130 |
< |
* nothing especially magic about obtaining this constant from a |
131 |
< |
* "truly random" physical source rather than just choosing one |
132 |
< |
* arbitrarily; using "hotbits" was merely an aesthetically pleasing |
133 |
< |
* choice. In either case, good statistical behavior of the |
134 |
< |
* algorithm should be, and was, verified by using the DieHarder |
135 |
< |
* test suite.) |
136 |
< |
* |
137 |
< |
* The mix64 bit-mixing function called by nextLong and other |
138 |
< |
* methods computes the same value as the "64-bit finalizer" |
139 |
< |
* function in Austin Appleby's MurmurHash3 algorithm. See |
140 |
< |
* http://code.google.com/p/smhasher/wiki/MurmurHash3 , which |
141 |
< |
* comments: "The constants for the finalizers were generated by a |
142 |
< |
* simple simulated-annealing algorithm, and both avalanche all |
143 |
< |
* bits of 'h' to within 0.25% bias." It also appears to work to |
144 |
< |
* use instead any of the variants proposed by David Stafford at |
145 |
< |
* http://zimbry.blogspot.com/2011/09/better-bit-mixing-improving-on.html |
146 |
< |
* but these variants have not yet been tested as thoroughly |
147 |
< |
* in the context of the implementation of SplittableRandom. |
148 |
< |
* |
149 |
< |
* The mix32 function used for nextInt just consists of two of the |
150 |
< |
* five lines of mix64; avalanche testing shows that the 64-bit result |
151 |
< |
* has its top 32 bits avalanched well, though not the bottom 32 bits. |
152 |
< |
* DieHarder tests show that it is adequate for generating one |
153 |
< |
* random int from the 64-bit result of nextSeed. |
154 |
< |
* |
155 |
< |
* Support for the default (no-argument) constructor relies on an |
156 |
< |
* AtomicLong (defaultSeedGenerator) to help perform the |
157 |
< |
* equivalent of a split of a statically constructed |
158 |
< |
* SplittableRandom. Unlike other cases, this split must be |
159 |
< |
* performed in a thread-safe manner. We use |
160 |
< |
* AtomicLong.compareAndSet as the (typically) most efficient |
161 |
< |
* mechanism. To bootstrap, we start off using a function of the |
162 |
< |
* current System time as seed, and update using another |
163 |
< |
* "genuinely random" constant DEFAULT_SEED_GAMMA. The default |
164 |
< |
* constructor uses GAMMA_GAMMA, not 0, for its splitSeed argument |
165 |
< |
* (addGammaModGeorge(0, GAMMA_GAMMA) == GAMMA_GAMMA) to reflect |
166 |
< |
* that each is split from this root generator, even though the |
167 |
< |
* root is not explicitly represented as a SplittableRandom. When |
168 |
< |
* establishing the initial seed, we use both |
169 |
< |
* System.currentTimeMillis and System.nanoTime(), to avoid |
170 |
< |
* regularities that may occur if using either alone. |
171 |
< |
*/ |
172 |
< |
|
173 |
< |
/** |
174 |
< |
* The "genuinely random" value for producing new gamma values. |
175 |
< |
* The value is arbitrary, subject to the requirement that it be |
176 |
< |
* greater or equal to 13. |
177 |
< |
*/ |
178 |
< |
private static final long GAMMA_GAMMA = 0xF2281E2DBA6606F3L; |
179 |
< |
|
180 |
< |
/** |
181 |
< |
* The "genuinely random" seed update value for default constructors. |
182 |
< |
* The value is arbitrary, subject to the requirement that it be |
183 |
< |
* greater or equal to 13. |
152 |
> |
* File organization: First the non-public methods that constitute |
153 |
> |
* the main algorithm, then the main public methods, followed by |
154 |
> |
* some custom spliterator classes needed for stream methods. |
155 |
|
*/ |
185 |
– |
private static final long DEFAULT_SEED_GAMMA = 0xBD24B73A95FB84D9L; |
156 |
|
|
157 |
|
/** |
158 |
< |
* The value 13 with 64bit sign bit set. Used in the signed |
159 |
< |
* comparison in addGammaModGeorge. |
158 |
> |
* The golden ratio scaled to 64bits, used as the initial gamma |
159 |
> |
* value for (unsplit) SplittableRandoms. |
160 |
|
*/ |
161 |
< |
private static final long BOTTOM13 = 0x800000000000000DL; |
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 next seed for default constructors. |
201 |
< |
*/ |
202 |
< |
private static final AtomicLong defaultSeedGenerator = |
203 |
< |
new AtomicLong(mix64(System.currentTimeMillis()) ^ |
204 |
< |
mix64(System.nanoTime())); |
205 |
< |
|
206 |
< |
/** |
207 |
< |
* The seed, updated only via method nextSeed. |
170 |
> |
* The seed. Updated only via method nextSeed. |
171 |
|
*/ |
172 |
|
private long seed; |
173 |
|
|
174 |
|
/** |
175 |
< |
* The constant value added to seed (mod George) on each update. |
175 |
> |
* The step value. |
176 |
|
*/ |
177 |
|
private final long gamma; |
178 |
|
|
179 |
|
/** |
180 |
< |
* The next seed to use for splits. Propagated using |
218 |
< |
* addGammaModGeorge across instances. |
219 |
< |
*/ |
220 |
< |
private final long nextSplit; |
221 |
< |
|
222 |
< |
/** |
223 |
< |
* Adds the given gamma value, g, to the given seed value s, mod |
224 |
< |
* George (2^64+13). We regard s and g as unsigned values |
225 |
< |
* (ranging from 0 to 2^64-1). We add g to s either once or twice |
226 |
< |
* (mod George) as necessary to produce an (unsigned) result less |
227 |
< |
* than 2^64. We require that g must be at least 13. This |
228 |
< |
* guarantees that if (s+g) mod George >= 2^64 then (s+g+g) mod |
229 |
< |
* George < 2^64; thus we need only a conditional, not a loop, |
230 |
< |
* to be sure of getting a representable value. |
231 |
< |
* |
232 |
< |
* Because Java comparison operators are signed, we implement this |
233 |
< |
* by conceptually offsetting seed values downwards by 2^63, so |
234 |
< |
* 0..13 is represented as Long.MIN_VALUE..BOTTOM13. |
235 |
< |
* |
236 |
< |
* @param s a seed value, viewed as a signed long |
237 |
< |
* @param g a gamma value, 13 <= g (as unsigned) |
180 |
> |
* Internal constructor used by all others except default constructor. |
181 |
|
*/ |
182 |
< |
private static long addGammaModGeorge(long s, long g) { |
183 |
< |
long p = s + g; |
184 |
< |
return (p >= s) ? p : ((p >= BOTTOM13) ? p : p + g) - 13L; |
182 |
> |
private SplittableRandom(long seed, long gamma) { |
183 |
> |
this.seed = seed; |
184 |
> |
this.gamma = gamma; |
185 |
|
} |
186 |
|
|
187 |
|
/** |
188 |
< |
* Returns a bit-mixed transformation of its argument. |
246 |
< |
* See above for explanation. |
188 |
> |
* Computes Stafford variant 13 of 64bit mix function. |
189 |
|
*/ |
190 |
|
private static long mix64(long z) { |
191 |
< |
z ^= (z >>> 33); |
192 |
< |
z *= 0xff51afd7ed558ccdL; |
193 |
< |
z ^= (z >>> 33); |
252 |
< |
z *= 0xc4ceb9fe1a85ec53L; |
253 |
< |
z ^= (z >>> 33); |
254 |
< |
return z; |
191 |
> |
z = (z ^ (z >>> 30)) * 0xbf58476d1ce4e5b9L; |
192 |
> |
z = (z ^ (z >>> 27)) * 0x94d049bb133111ebL; |
193 |
> |
return z ^ (z >>> 31); |
194 |
|
} |
195 |
|
|
196 |
|
/** |
197 |
< |
* Returns a bit-mixed int transformation of its argument. |
259 |
< |
* See above for explanation. |
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 >>> 33); |
201 |
< |
z *= 0xc4ceb9fe1a85ec53L; |
264 |
< |
return (int)(z >>> 32); |
200 |
> |
z = (z ^ (z >>> 33)) * 0x62a9d9ed799705f5L; |
201 |
> |
return (int)(((z ^ (z >>> 28)) * 0xcb24d0a5c88c35b3L) >>> 32); |
202 |
|
} |
203 |
|
|
204 |
|
/** |
205 |
< |
* Internal constructor used by all other constructors and by |
269 |
< |
* method split. Establishes the initial seed for this instance, |
270 |
< |
* and uses the given splitSeed to establish gamma, as well as the |
271 |
< |
* nextSplit to use by this instance. The loop to skip ineligible |
272 |
< |
* gammas very rarely iterates, and does so at most 13 times. |
205 |
> |
* Returns the gamma value to use for a new split instance. |
206 |
|
*/ |
207 |
< |
private SplittableRandom(long seed, long splitSeed) { |
208 |
< |
this.seed = seed; |
209 |
< |
long s = splitSeed, g; |
210 |
< |
do { // ensure gamma >= 13, considered as an unsigned integer |
211 |
< |
s = addGammaModGeorge(s, GAMMA_GAMMA); |
212 |
< |
g = mix64(s); |
280 |
< |
} while (g >= 0L && g < 13L); |
281 |
< |
this.gamma = g; |
282 |
< |
this.nextSplit = s; |
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 |
|
/** |
216 |
< |
* Updates in-place and returns seed. |
287 |
< |
* See above for explanation. |
216 |
> |
* Adds gamma to seed. |
217 |
|
*/ |
218 |
|
private long nextSeed() { |
219 |
< |
return seed = addGammaModGeorge(seed, gamma); |
219 |
> |
return seed += gamma; |
220 |
|
} |
221 |
|
|
222 |
< |
/** |
223 |
< |
* Atomically updates and returns next seed for default constructor. |
224 |
< |
*/ |
225 |
< |
private static long nextDefaultSeed() { |
226 |
< |
long oldSeed, newSeed; |
227 |
< |
do { |
228 |
< |
oldSeed = defaultSeedGenerator.get(); |
229 |
< |
newSeed = addGammaModGeorge(oldSeed, DEFAULT_SEED_GAMMA); |
230 |
< |
} while (!defaultSeedGenerator.compareAndSet(oldSeed, newSeed)); |
231 |
< |
return mix64(newSeed); |
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 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 |
|
|
249 |
|
/* |
321 |
|
int r = mix32(nextSeed()); |
322 |
|
if (origin < bound) { |
323 |
|
int n = bound - origin, m = n - 1; |
324 |
< |
if ((n & m) == 0L) |
324 |
> |
if ((n & m) == 0) |
325 |
|
r = (r & m) + origin; |
326 |
|
else if (n > 0) { |
327 |
|
for (int u = r >>> 1; |
365 |
|
* @param seed the initial seed |
366 |
|
*/ |
367 |
|
public SplittableRandom(long seed) { |
368 |
< |
this(seed, 0); |
368 |
> |
this(seed, GOLDEN_GAMMA); |
369 |
|
} |
370 |
|
|
371 |
|
/** |
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() { |
378 |
< |
this(nextDefaultSeed(), GAMMA_GAMMA); |
377 |
> |
public SplittableRandom() { // emulate defaultGen.split() |
378 |
> |
long s = defaultGen.getAndAdd(2 * GOLDEN_GAMMA); |
379 |
> |
this.seed = mix64(s); |
380 |
> |
this.gamma = mixGamma(s + GOLDEN_GAMMA); |
381 |
|
} |
382 |
|
|
383 |
|
/** |
395 |
|
* @return the new SplittableRandom instance |
396 |
|
*/ |
397 |
|
public SplittableRandom split() { |
398 |
< |
return new SplittableRandom(nextSeed(), nextSplit); |
398 |
> |
return new SplittableRandom(nextLong(), mixGamma(nextSeed())); |
399 |
|
} |
400 |
|
|
401 |
|
/** |
411 |
|
* Returns a pseudorandom {@code int} value between zero (inclusive) |
412 |
|
* and the specified bound (exclusive). |
413 |
|
* |
414 |
< |
* @param bound the bound on the random number to be returned. Must be |
469 |
< |
* positive. |
414 |
> |
* @param bound the upper bound (exclusive). Must be positive. |
415 |
|
* @return a pseudorandom {@code int} value between zero |
416 |
|
* (inclusive) and the bound (exclusive) |
417 |
< |
* @throws IllegalArgumentException if the bound is less than zero |
417 |
> |
* @throws IllegalArgumentException if {@code bound} is not positive |
418 |
|
*/ |
419 |
|
public int nextInt(int bound) { |
420 |
|
if (bound <= 0) |
421 |
< |
throw new IllegalArgumentException("bound must be positive"); |
421 |
> |
throw new IllegalArgumentException(BAD_BOUND); |
422 |
|
// Specialize internalNextInt for origin 0 |
423 |
|
int r = mix32(nextSeed()); |
424 |
|
int m = bound - 1; |
425 |
< |
if ((bound & m) == 0L) // power of two |
425 |
> |
if ((bound & m) == 0) // power of two |
426 |
|
r &= m; |
427 |
|
else { // reject over-represented candidates |
428 |
|
for (int u = r >>> 1; |
446 |
|
*/ |
447 |
|
public int nextInt(int origin, int bound) { |
448 |
|
if (origin >= bound) |
449 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
449 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
450 |
|
return internalNextInt(origin, bound); |
451 |
|
} |
452 |
|
|
463 |
|
* Returns a pseudorandom {@code long} value between zero (inclusive) |
464 |
|
* and the specified bound (exclusive). |
465 |
|
* |
466 |
< |
* @param bound the bound on the random number to be returned. Must be |
522 |
< |
* positive. |
466 |
> |
* @param bound the upper bound (exclusive). Must be positive. |
467 |
|
* @return a pseudorandom {@code long} value between zero |
468 |
|
* (inclusive) and the bound (exclusive) |
469 |
< |
* @throws IllegalArgumentException if {@code bound} is less than zero |
469 |
> |
* @throws IllegalArgumentException if {@code bound} is not positive |
470 |
|
*/ |
471 |
|
public long nextLong(long bound) { |
472 |
|
if (bound <= 0) |
473 |
< |
throw new IllegalArgumentException("bound must be positive"); |
473 |
> |
throw new IllegalArgumentException(BAD_BOUND); |
474 |
|
// Specialize internalNextLong for origin 0 |
475 |
|
long r = mix64(nextSeed()); |
476 |
|
long m = bound - 1; |
498 |
|
*/ |
499 |
|
public long nextLong(long origin, long bound) { |
500 |
|
if (origin >= bound) |
501 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
501 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
502 |
|
return internalNextLong(origin, bound); |
503 |
|
} |
504 |
|
|
507 |
|
* (inclusive) and one (exclusive). |
508 |
|
* |
509 |
|
* @return a pseudorandom {@code double} value between zero |
510 |
< |
* (inclusive) and one (exclusive) |
510 |
> |
* (inclusive) and one (exclusive) |
511 |
|
*/ |
512 |
|
public double nextDouble() { |
513 |
|
return (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT; |
517 |
|
* Returns a pseudorandom {@code double} value between 0.0 |
518 |
|
* (inclusive) and the specified bound (exclusive). |
519 |
|
* |
520 |
< |
* @param bound the bound on the random number to be returned. Must be |
577 |
< |
* positive. |
520 |
> |
* @param bound the upper bound (exclusive). Must be positive. |
521 |
|
* @return a pseudorandom {@code double} value between zero |
522 |
|
* (inclusive) and the bound (exclusive) |
523 |
< |
* @throws IllegalArgumentException if {@code bound} is less than zero |
523 |
> |
* @throws IllegalArgumentException if {@code bound} is not positive |
524 |
|
*/ |
525 |
|
public double nextDouble(double bound) { |
526 |
|
if (!(bound > 0.0)) |
527 |
< |
throw new IllegalArgumentException("bound must be positive"); |
527 |
> |
throw new IllegalArgumentException(BAD_BOUND); |
528 |
|
double result = (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT * bound; |
529 |
|
return (result < bound) ? result : // correct for rounding |
530 |
|
Double.longBitsToDouble(Double.doubleToLongBits(bound) - 1); |
531 |
|
} |
532 |
|
|
533 |
|
/** |
534 |
+ |
* Generates a pseudorandom number with the indicated number of |
535 |
+ |
* low-order bits. Because this class has no subclasses, this |
536 |
+ |
* method cannot be invoked or overridden. |
537 |
+ |
* |
538 |
+ |
* @param bits random bits |
539 |
+ |
* @return the next pseudorandom value from this random number |
540 |
+ |
* generator's sequence |
541 |
+ |
*/ |
542 |
+ |
protected int next(int bits) { |
543 |
+ |
return nextInt() >>> (32 - bits); |
544 |
+ |
} |
545 |
+ |
|
546 |
+ |
/** |
547 |
|
* Returns a pseudorandom {@code double} value between the specified |
548 |
|
* origin (inclusive) and bound (exclusive). |
549 |
|
* |
550 |
|
* @param origin the least value returned |
551 |
< |
* @param bound the upper bound |
551 |
> |
* @param bound the upper bound (exclusive) |
552 |
|
* @return a pseudorandom {@code double} value between the origin |
553 |
|
* (inclusive) and the bound (exclusive) |
554 |
|
* @throws IllegalArgumentException if {@code origin} is greater than |
556 |
|
*/ |
557 |
|
public double nextDouble(double origin, double bound) { |
558 |
|
if (!(origin < bound)) |
559 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
559 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
560 |
|
return internalNextDouble(origin, bound); |
561 |
|
} |
562 |
|
|
573 |
|
// maintenance purposes the small differences across forms. |
574 |
|
|
575 |
|
/** |
576 |
< |
* Returns a stream producing the given {@code streamSize} number of |
577 |
< |
* pseudorandom {@code int} values. |
576 |
> |
* Returns a stream producing the given {@code streamSize} number |
577 |
> |
* of pseudorandom {@code int} values from this generator and/or |
578 |
> |
* one split from it. |
579 |
|
* |
580 |
|
* @param streamSize the number of values to generate |
581 |
|
* @return a stream of pseudorandom {@code int} values |
584 |
|
*/ |
585 |
|
public IntStream ints(long streamSize) { |
586 |
|
if (streamSize < 0L) |
587 |
< |
throw new IllegalArgumentException("negative Stream size"); |
587 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
588 |
|
return StreamSupport.intStream |
589 |
|
(new RandomIntsSpliterator |
590 |
|
(this, 0L, streamSize, Integer.MAX_VALUE, 0), |
593 |
|
|
594 |
|
/** |
595 |
|
* Returns an effectively unlimited stream of pseudorandom {@code int} |
596 |
< |
* values. |
596 |
> |
* values from this generator and/or one split from it. |
597 |
|
* |
598 |
|
* @implNote This method is implemented to be equivalent to {@code |
599 |
|
* ints(Long.MAX_VALUE)}. |
608 |
|
} |
609 |
|
|
610 |
|
/** |
611 |
< |
* Returns a stream producing the given {@code streamSize} number of |
612 |
< |
* pseudorandom {@code int} values, each conforming to the given |
613 |
< |
* origin and bound. |
611 |
> |
* Returns a stream producing the given {@code streamSize} number |
612 |
> |
* of pseudorandom {@code int} values from this generator and/or one split |
613 |
> |
* from it; each value conforms to the given origin (inclusive) and bound |
614 |
> |
* (exclusive). |
615 |
|
* |
616 |
|
* @param streamSize the number of values to generate |
617 |
< |
* @param randomNumberOrigin the origin of each random value |
618 |
< |
* @param randomNumberBound the bound of each random value |
617 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
618 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
619 |
|
* @return a stream of pseudorandom {@code int} values, |
620 |
< |
* each with the given origin and bound |
620 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
621 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
622 |
|
* less than zero, or {@code randomNumberOrigin} |
623 |
|
* is greater than or equal to {@code randomNumberBound} |
625 |
|
public IntStream ints(long streamSize, int randomNumberOrigin, |
626 |
|
int randomNumberBound) { |
627 |
|
if (streamSize < 0L) |
628 |
< |
throw new IllegalArgumentException("negative Stream size"); |
628 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
629 |
|
if (randomNumberOrigin >= randomNumberBound) |
630 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
630 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
631 |
|
return StreamSupport.intStream |
632 |
|
(new RandomIntsSpliterator |
633 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
636 |
|
|
637 |
|
/** |
638 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
639 |
< |
* int} values, each conforming to the given origin and bound. |
639 |
> |
* int} values from this generator and/or one split from it; each value |
640 |
> |
* conforms to the given origin (inclusive) and bound (exclusive). |
641 |
|
* |
642 |
|
* @implNote This method is implemented to be equivalent to {@code |
643 |
|
* ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}. |
644 |
|
* |
645 |
< |
* @param randomNumberOrigin the origin of each random value |
646 |
< |
* @param randomNumberBound the bound of each random value |
645 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
646 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
647 |
|
* @return a stream of pseudorandom {@code int} values, |
648 |
< |
* each with the given origin and bound |
648 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
649 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
650 |
|
* is greater than or equal to {@code randomNumberBound} |
651 |
|
*/ |
652 |
|
public IntStream ints(int randomNumberOrigin, int randomNumberBound) { |
653 |
|
if (randomNumberOrigin >= randomNumberBound) |
654 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
654 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
655 |
|
return StreamSupport.intStream |
656 |
|
(new RandomIntsSpliterator |
657 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
659 |
|
} |
660 |
|
|
661 |
|
/** |
662 |
< |
* Returns a stream producing the given {@code streamSize} number of |
663 |
< |
* pseudorandom {@code long} values. |
662 |
> |
* Returns a stream producing the given {@code streamSize} number |
663 |
> |
* of pseudorandom {@code long} values from this generator and/or |
664 |
> |
* one split from it. |
665 |
|
* |
666 |
|
* @param streamSize the number of values to generate |
667 |
|
* @return a stream of pseudorandom {@code long} values |
670 |
|
*/ |
671 |
|
public LongStream longs(long streamSize) { |
672 |
|
if (streamSize < 0L) |
673 |
< |
throw new IllegalArgumentException("negative Stream size"); |
673 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
674 |
|
return StreamSupport.longStream |
675 |
|
(new RandomLongsSpliterator |
676 |
|
(this, 0L, streamSize, Long.MAX_VALUE, 0L), |
678 |
|
} |
679 |
|
|
680 |
|
/** |
681 |
< |
* Returns an effectively unlimited stream of pseudorandom {@code long} |
682 |
< |
* values. |
681 |
> |
* Returns an effectively unlimited stream of pseudorandom {@code |
682 |
> |
* long} values from this generator and/or one split from it. |
683 |
|
* |
684 |
|
* @implNote This method is implemented to be equivalent to {@code |
685 |
|
* longs(Long.MAX_VALUE)}. |
695 |
|
|
696 |
|
/** |
697 |
|
* Returns a stream producing the given {@code streamSize} number of |
698 |
< |
* pseudorandom {@code long} values, each conforming to the |
699 |
< |
* given origin and bound. |
698 |
> |
* pseudorandom {@code long} values from this generator and/or one split |
699 |
> |
* from it; each value conforms to the given origin (inclusive) and bound |
700 |
> |
* (exclusive). |
701 |
|
* |
702 |
|
* @param streamSize the number of values to generate |
703 |
< |
* @param randomNumberOrigin the origin of each random value |
704 |
< |
* @param randomNumberBound the bound of each random value |
703 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
704 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
705 |
|
* @return a stream of pseudorandom {@code long} values, |
706 |
< |
* each with the given origin and bound |
706 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
707 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
708 |
|
* less than zero, or {@code randomNumberOrigin} |
709 |
|
* is greater than or equal to {@code randomNumberBound} |
711 |
|
public LongStream longs(long streamSize, long randomNumberOrigin, |
712 |
|
long randomNumberBound) { |
713 |
|
if (streamSize < 0L) |
714 |
< |
throw new IllegalArgumentException("negative Stream size"); |
714 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
715 |
|
if (randomNumberOrigin >= randomNumberBound) |
716 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
716 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
717 |
|
return StreamSupport.longStream |
718 |
|
(new RandomLongsSpliterator |
719 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
722 |
|
|
723 |
|
/** |
724 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
725 |
< |
* long} values, each conforming to the given origin and bound. |
725 |
> |
* long} values from this generator and/or one split from it; each value |
726 |
> |
* conforms to the given origin (inclusive) and bound (exclusive). |
727 |
|
* |
728 |
|
* @implNote This method is implemented to be equivalent to {@code |
729 |
|
* longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}. |
730 |
|
* |
731 |
< |
* @param randomNumberOrigin the origin of each random value |
732 |
< |
* @param randomNumberBound the bound of each random value |
731 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
732 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
733 |
|
* @return a stream of pseudorandom {@code long} values, |
734 |
< |
* each with the given origin and bound |
734 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
735 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
736 |
|
* is greater than or equal to {@code randomNumberBound} |
737 |
|
*/ |
738 |
|
public LongStream longs(long randomNumberOrigin, long randomNumberBound) { |
739 |
|
if (randomNumberOrigin >= randomNumberBound) |
740 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
740 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
741 |
|
return StreamSupport.longStream |
742 |
|
(new RandomLongsSpliterator |
743 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
746 |
|
|
747 |
|
/** |
748 |
|
* Returns a stream producing the given {@code streamSize} number of |
749 |
< |
* pseudorandom {@code double} values, each between zero |
750 |
< |
* (inclusive) and one (exclusive). |
749 |
> |
* pseudorandom {@code double} values from this generator and/or one split |
750 |
> |
* from it; each value is between zero (inclusive) and one (exclusive). |
751 |
|
* |
752 |
|
* @param streamSize the number of values to generate |
753 |
|
* @return a stream of {@code double} values |
756 |
|
*/ |
757 |
|
public DoubleStream doubles(long streamSize) { |
758 |
|
if (streamSize < 0L) |
759 |
< |
throw new IllegalArgumentException("negative Stream size"); |
759 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
760 |
|
return StreamSupport.doubleStream |
761 |
|
(new RandomDoublesSpliterator |
762 |
|
(this, 0L, streamSize, Double.MAX_VALUE, 0.0), |
765 |
|
|
766 |
|
/** |
767 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
768 |
< |
* double} values, each between zero (inclusive) and one |
769 |
< |
* (exclusive). |
768 |
> |
* double} values from this generator and/or one split from it; each value |
769 |
> |
* is between zero (inclusive) and one (exclusive). |
770 |
|
* |
771 |
|
* @implNote This method is implemented to be equivalent to {@code |
772 |
|
* doubles(Long.MAX_VALUE)}. |
782 |
|
|
783 |
|
/** |
784 |
|
* Returns a stream producing the given {@code streamSize} number of |
785 |
< |
* pseudorandom {@code double} values, each conforming to the |
786 |
< |
* given origin and bound. |
785 |
> |
* pseudorandom {@code double} values from this generator and/or one split |
786 |
> |
* from it; each value conforms to the given origin (inclusive) and bound |
787 |
> |
* (exclusive). |
788 |
|
* |
789 |
|
* @param streamSize the number of values to generate |
790 |
< |
* @param randomNumberOrigin the origin of each random value |
791 |
< |
* @param randomNumberBound the bound of each random value |
790 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
791 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
792 |
|
* @return a stream of pseudorandom {@code double} values, |
793 |
< |
* each with the given origin and bound |
793 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
794 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
795 |
< |
* less than zero |
795 |
> |
* less than zero |
796 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
797 |
|
* is greater than or equal to {@code randomNumberBound} |
798 |
|
*/ |
799 |
|
public DoubleStream doubles(long streamSize, double randomNumberOrigin, |
800 |
|
double randomNumberBound) { |
801 |
|
if (streamSize < 0L) |
802 |
< |
throw new IllegalArgumentException("negative Stream size"); |
802 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
803 |
|
if (!(randomNumberOrigin < randomNumberBound)) |
804 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
804 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
805 |
|
return StreamSupport.doubleStream |
806 |
|
(new RandomDoublesSpliterator |
807 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
810 |
|
|
811 |
|
/** |
812 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
813 |
< |
* double} values, each conforming to the given origin and bound. |
813 |
> |
* double} values from this generator and/or one split from it; each value |
814 |
> |
* conforms to the given origin (inclusive) and bound (exclusive). |
815 |
|
* |
816 |
|
* @implNote This method is implemented to be equivalent to {@code |
817 |
|
* doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}. |
818 |
|
* |
819 |
< |
* @param randomNumberOrigin the origin of each random value |
820 |
< |
* @param randomNumberBound the bound of each random value |
819 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
820 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
821 |
|
* @return a stream of pseudorandom {@code double} values, |
822 |
< |
* each with the given origin and bound |
822 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
823 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
824 |
|
* is greater than or equal to {@code randomNumberBound} |
825 |
|
*/ |
826 |
|
public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) { |
827 |
|
if (!(randomNumberOrigin < randomNumberBound)) |
828 |
< |
throw new IllegalArgumentException("bound must be greater than origin"); |
828 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
829 |
|
return StreamSupport.doubleStream |
830 |
|
(new RandomDoublesSpliterator |
831 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
840 |
|
* approach. The long and double versions of this class are |
841 |
|
* identical except for types. |
842 |
|
*/ |
843 |
< |
static final class RandomIntsSpliterator implements Spliterator.OfInt { |
843 |
> |
private static final class RandomIntsSpliterator |
844 |
> |
implements Spliterator.OfInt { |
845 |
|
final SplittableRandom rng; |
846 |
|
long index; |
847 |
|
final long fence; |
884 |
|
long i = index, f = fence; |
885 |
|
if (i < f) { |
886 |
|
index = f; |
887 |
+ |
SplittableRandom r = rng; |
888 |
|
int o = origin, b = bound; |
889 |
|
do { |
890 |
< |
consumer.accept(rng.internalNextInt(o, b)); |
890 |
> |
consumer.accept(r.internalNextInt(o, b)); |
891 |
|
} while (++i < f); |
892 |
|
} |
893 |
|
} |
896 |
|
/** |
897 |
|
* Spliterator for long streams. |
898 |
|
*/ |
899 |
< |
static final class RandomLongsSpliterator implements Spliterator.OfLong { |
899 |
> |
private static final class RandomLongsSpliterator |
900 |
> |
implements Spliterator.OfLong { |
901 |
|
final SplittableRandom rng; |
902 |
|
long index; |
903 |
|
final long fence; |
940 |
|
long i = index, f = fence; |
941 |
|
if (i < f) { |
942 |
|
index = f; |
943 |
+ |
SplittableRandom r = rng; |
944 |
|
long o = origin, b = bound; |
945 |
|
do { |
946 |
< |
consumer.accept(rng.internalNextLong(o, b)); |
946 |
> |
consumer.accept(r.internalNextLong(o, b)); |
947 |
|
} while (++i < f); |
948 |
|
} |
949 |
|
} |
953 |
|
/** |
954 |
|
* Spliterator for double streams. |
955 |
|
*/ |
956 |
< |
static final class RandomDoublesSpliterator implements Spliterator.OfDouble { |
956 |
> |
private static final class RandomDoublesSpliterator |
957 |
> |
implements Spliterator.OfDouble { |
958 |
|
final SplittableRandom rng; |
959 |
|
long index; |
960 |
|
final long fence; |
997 |
|
long i = index, f = fence; |
998 |
|
if (i < f) { |
999 |
|
index = f; |
1000 |
+ |
SplittableRandom r = rng; |
1001 |
|
double o = origin, b = bound; |
1002 |
|
do { |
1003 |
< |
consumer.accept(rng.internalNextDouble(o, b)); |
1003 |
> |
consumer.accept(r.internalNextDouble(o, b)); |
1004 |
|
} while (++i < f); |
1005 |
|
} |
1006 |
|
} |