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: |
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 { |
89 |
> |
public final class SplittableRandom { |
90 |
|
|
91 |
|
/* |
92 |
|
* Implementation Overview. |
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. |
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 |
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. |
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 |
|
/** |
219 |
|
return seed += gamma; |
220 |
|
} |
221 |
|
|
222 |
+ |
// IllegalArgumentException messages |
223 |
+ |
static final String BAD_BOUND = "bound must be positive"; |
224 |
+ |
static final String BAD_RANGE = "bound must be greater than origin"; |
225 |
+ |
static final String BAD_SIZE = "size must be non-negative"; |
226 |
+ |
|
227 |
|
/** |
228 |
|
* The seed generator for default constructors. |
229 |
|
*/ |
230 |
< |
private static final AtomicLong seeder = |
231 |
< |
new AtomicLong(mix64((((long)hashedHostAddress()) << 32) ^ |
232 |
< |
System.currentTimeMillis()) ^ |
233 |
< |
mix64(System.nanoTime())); |
234 |
< |
|
235 |
< |
/** |
236 |
< |
* Returns hash of local host IP address, if available; else 0. |
237 |
< |
*/ |
238 |
< |
private static int hashedHostAddress() { |
239 |
< |
try { |
240 |
< |
return InetAddress.getLocalHost().hashCode(); |
241 |
< |
} catch (Exception ex) { |
242 |
< |
return 0; |
243 |
< |
} |
230 |
> |
private static final AtomicLong defaultGen |
231 |
> |
= new AtomicLong(mix64(System.currentTimeMillis()) ^ |
232 |
> |
mix64(System.nanoTime())); |
233 |
> |
|
234 |
> |
// at end of <clinit> to survive static initialization circularity |
235 |
> |
static { |
236 |
> |
if (java.security.AccessController.doPrivileged( |
237 |
> |
new java.security.PrivilegedAction<Boolean>() { |
238 |
> |
public Boolean run() { |
239 |
> |
return Boolean.getBoolean("java.util.secureRandomSeed"); |
240 |
> |
}})) { |
241 |
> |
byte[] seedBytes = java.security.SecureRandom.getSeed(8); |
242 |
> |
long s = (long)seedBytes[0] & 0xffL; |
243 |
> |
for (int i = 1; i < 8; ++i) |
244 |
> |
s = (s << 8) | ((long)seedBytes[i] & 0xffL); |
245 |
> |
defaultGen.set(s); |
246 |
> |
} |
247 |
|
} |
248 |
|
|
240 |
– |
// IllegalArgumentException messages |
241 |
– |
static final String BadBound = "bound must be positive"; |
242 |
– |
static final String BadRange = "bound must be greater than origin"; |
243 |
– |
static final String BadSize = "size must be non-negative"; |
244 |
– |
|
249 |
|
/* |
250 |
|
* Internal versions of nextX methods used by streams, as well as |
251 |
|
* the public nextX(origin, bound) methods. These exist mainly to |
365 |
|
* @param seed the initial seed |
366 |
|
*/ |
367 |
|
public SplittableRandom(long seed) { |
368 |
< |
this(seed, INITIAL_GAMMA); |
368 |
> |
this(seed, GOLDEN_GAMMA); |
369 |
|
} |
370 |
|
|
371 |
|
/** |
374 |
|
* of those of any other instances in the current program; and |
375 |
|
* may, and typically does, vary across program invocations. |
376 |
|
*/ |
377 |
< |
public SplittableRandom() { // emulate seeder.split() |
378 |
< |
this.gamma = nextGamma(this.seed = seeder.addAndGet(INITIAL_GAMMA)); |
377 |
> |
public SplittableRandom() { // emulate defaultGen.split() |
378 |
> |
long s = defaultGen.getAndAdd(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 |
< |
long s = nextSeed(); |
393 |
< |
return new SplittableRandom(s, nextGamma(s)); |
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 |
410 |
< |
* positive. |
414 |
> |
* @param bound the upper bound (exclusive). Must be positive. |
415 |
|
* @return a pseudorandom {@code int} value between zero |
416 |
|
* (inclusive) and the bound (exclusive) |
417 |
< |
* @throws IllegalArgumentException if 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(BadBound); |
421 |
> |
throw new IllegalArgumentException(BAD_BOUND); |
422 |
|
// Specialize internalNextInt for origin 0 |
423 |
|
int r = mix32(nextSeed()); |
424 |
|
int m = bound - 1; |
446 |
|
*/ |
447 |
|
public int nextInt(int origin, int bound) { |
448 |
|
if (origin >= bound) |
449 |
< |
throw new IllegalArgumentException(BadRange); |
449 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
450 |
|
return internalNextInt(origin, bound); |
451 |
|
} |
452 |
|
|
463 |
|
* Returns a pseudorandom {@code long} value between zero (inclusive) |
464 |
|
* and the specified bound (exclusive). |
465 |
|
* |
466 |
< |
* @param bound the bound on the random number to be returned. Must be |
463 |
< |
* positive. |
466 |
> |
* @param bound the upper bound (exclusive). Must be positive. |
467 |
|
* @return a pseudorandom {@code long} value between zero |
468 |
|
* (inclusive) and the bound (exclusive) |
469 |
< |
* @throws IllegalArgumentException if {@code bound} is 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(BadBound); |
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(BadRange); |
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 |
518 |
< |
* positive. |
520 |
> |
* @param bound the upper bound (exclusive). Must be positive. |
521 |
|
* @return a pseudorandom {@code double} value between zero |
522 |
|
* (inclusive) and the bound (exclusive) |
523 |
< |
* @throws IllegalArgumentException if {@code bound} is 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(BadBound); |
527 |
> |
throw new IllegalArgumentException(BAD_BOUND); |
528 |
|
double result = (mix64(nextSeed()) >>> 11) * DOUBLE_UNIT * bound; |
529 |
|
return (result < bound) ? result : // correct for rounding |
530 |
|
Double.longBitsToDouble(Double.doubleToLongBits(bound) - 1); |
531 |
|
} |
532 |
|
|
533 |
|
/** |
534 |
+ |
* Generates a pseudorandom number with the indicated number of |
535 |
+ |
* bits. Unlike in superclass @{link Random}, this method is never |
536 |
+ |
* internally called or used by any other publicly accessible |
537 |
+ |
* method. |
538 |
+ |
* |
539 |
+ |
* @param bits random bits |
540 |
+ |
* @return the next pseudorandom value from this random number |
541 |
+ |
* generator's sequence |
542 |
+ |
*/ |
543 |
+ |
protected int next(int bits) { |
544 |
+ |
return (int)(nextLong() >>> (64 - bits)); |
545 |
+ |
} |
546 |
+ |
|
547 |
+ |
/** |
548 |
|
* Returns a pseudorandom {@code double} value between the specified |
549 |
|
* origin (inclusive) and bound (exclusive). |
550 |
|
* |
551 |
|
* @param origin the least value returned |
552 |
< |
* @param bound the upper bound |
552 |
> |
* @param bound the upper bound (exclusive) |
553 |
|
* @return a pseudorandom {@code double} value between the origin |
554 |
|
* (inclusive) and the bound (exclusive) |
555 |
|
* @throws IllegalArgumentException if {@code origin} is greater than |
557 |
|
*/ |
558 |
|
public double nextDouble(double origin, double bound) { |
559 |
|
if (!(origin < bound)) |
560 |
< |
throw new IllegalArgumentException(BadRange); |
560 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
561 |
|
return internalNextDouble(origin, bound); |
562 |
|
} |
563 |
|
|
574 |
|
// maintenance purposes the small differences across forms. |
575 |
|
|
576 |
|
/** |
577 |
< |
* Returns a stream producing the given {@code streamSize} number of |
578 |
< |
* pseudorandom {@code int} values. |
577 |
> |
* Returns a stream producing the given {@code streamSize} number |
578 |
> |
* of pseudorandom {@code int} values from this generator and/or |
579 |
> |
* one split from it. |
580 |
|
* |
581 |
|
* @param streamSize the number of values to generate |
582 |
|
* @return a stream of pseudorandom {@code int} values |
585 |
|
*/ |
586 |
|
public IntStream ints(long streamSize) { |
587 |
|
if (streamSize < 0L) |
588 |
< |
throw new IllegalArgumentException(BadSize); |
588 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
589 |
|
return StreamSupport.intStream |
590 |
|
(new RandomIntsSpliterator |
591 |
|
(this, 0L, streamSize, Integer.MAX_VALUE, 0), |
594 |
|
|
595 |
|
/** |
596 |
|
* Returns an effectively unlimited stream of pseudorandom {@code int} |
597 |
< |
* values. |
597 |
> |
* values from this generator and/or one split from it. |
598 |
|
* |
599 |
|
* @implNote This method is implemented to be equivalent to {@code |
600 |
|
* ints(Long.MAX_VALUE)}. |
609 |
|
} |
610 |
|
|
611 |
|
/** |
612 |
< |
* Returns a stream producing the given {@code streamSize} number of |
613 |
< |
* pseudorandom {@code int} values, each conforming to the given |
614 |
< |
* origin and bound. |
612 |
> |
* Returns a stream producing the given {@code streamSize} number |
613 |
> |
* of pseudorandom {@code int} values from this generator and/or one split |
614 |
> |
* from it; each value conforms to the given origin (inclusive) and bound |
615 |
> |
* (exclusive). |
616 |
|
* |
617 |
|
* @param streamSize the number of values to generate |
618 |
< |
* @param randomNumberOrigin the origin of each random value |
619 |
< |
* @param randomNumberBound the bound of each random value |
618 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
619 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
620 |
|
* @return a stream of pseudorandom {@code int} values, |
621 |
< |
* each with the given origin and bound |
621 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
622 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
623 |
|
* less than zero, or {@code randomNumberOrigin} |
624 |
|
* is greater than or equal to {@code randomNumberBound} |
626 |
|
public IntStream ints(long streamSize, int randomNumberOrigin, |
627 |
|
int randomNumberBound) { |
628 |
|
if (streamSize < 0L) |
629 |
< |
throw new IllegalArgumentException(BadSize); |
629 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
630 |
|
if (randomNumberOrigin >= randomNumberBound) |
631 |
< |
throw new IllegalArgumentException(BadRange); |
631 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
632 |
|
return StreamSupport.intStream |
633 |
|
(new RandomIntsSpliterator |
634 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
637 |
|
|
638 |
|
/** |
639 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
640 |
< |
* int} values, each conforming to the given origin and bound. |
640 |
> |
* int} values from this generator and/or one split from it; each value |
641 |
> |
* conforms to the given origin (inclusive) and bound (exclusive). |
642 |
|
* |
643 |
|
* @implNote This method is implemented to be equivalent to {@code |
644 |
|
* ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}. |
645 |
|
* |
646 |
< |
* @param randomNumberOrigin the origin of each random value |
647 |
< |
* @param randomNumberBound the bound of each random value |
646 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
647 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
648 |
|
* @return a stream of pseudorandom {@code int} values, |
649 |
< |
* each with the given origin and bound |
649 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
650 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
651 |
|
* is greater than or equal to {@code randomNumberBound} |
652 |
|
*/ |
653 |
|
public IntStream ints(int randomNumberOrigin, int randomNumberBound) { |
654 |
|
if (randomNumberOrigin >= randomNumberBound) |
655 |
< |
throw new IllegalArgumentException(BadRange); |
655 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
656 |
|
return StreamSupport.intStream |
657 |
|
(new RandomIntsSpliterator |
658 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
660 |
|
} |
661 |
|
|
662 |
|
/** |
663 |
< |
* Returns a stream producing the given {@code streamSize} number of |
664 |
< |
* pseudorandom {@code long} values. |
663 |
> |
* Returns a stream producing the given {@code streamSize} number |
664 |
> |
* of pseudorandom {@code long} values from this generator and/or |
665 |
> |
* one split from it. |
666 |
|
* |
667 |
|
* @param streamSize the number of values to generate |
668 |
|
* @return a stream of pseudorandom {@code long} values |
671 |
|
*/ |
672 |
|
public LongStream longs(long streamSize) { |
673 |
|
if (streamSize < 0L) |
674 |
< |
throw new IllegalArgumentException(BadSize); |
674 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
675 |
|
return StreamSupport.longStream |
676 |
|
(new RandomLongsSpliterator |
677 |
|
(this, 0L, streamSize, Long.MAX_VALUE, 0L), |
679 |
|
} |
680 |
|
|
681 |
|
/** |
682 |
< |
* Returns an effectively unlimited stream of pseudorandom {@code long} |
683 |
< |
* values. |
682 |
> |
* Returns an effectively unlimited stream of pseudorandom {@code |
683 |
> |
* long} values from this generator and/or one split from it. |
684 |
|
* |
685 |
|
* @implNote This method is implemented to be equivalent to {@code |
686 |
|
* longs(Long.MAX_VALUE)}. |
696 |
|
|
697 |
|
/** |
698 |
|
* Returns a stream producing the given {@code streamSize} number of |
699 |
< |
* pseudorandom {@code long} values, each conforming to the |
700 |
< |
* given origin and bound. |
699 |
> |
* pseudorandom {@code long} values from this generator and/or one split |
700 |
> |
* from it; each value conforms to the given origin (inclusive) and bound |
701 |
> |
* (exclusive). |
702 |
|
* |
703 |
|
* @param streamSize the number of values to generate |
704 |
< |
* @param randomNumberOrigin the origin of each random value |
705 |
< |
* @param randomNumberBound the bound of each random value |
704 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
705 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
706 |
|
* @return a stream of pseudorandom {@code long} values, |
707 |
< |
* each with the given origin and bound |
707 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
708 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
709 |
|
* less than zero, or {@code randomNumberOrigin} |
710 |
|
* is greater than or equal to {@code randomNumberBound} |
712 |
|
public LongStream longs(long streamSize, long randomNumberOrigin, |
713 |
|
long randomNumberBound) { |
714 |
|
if (streamSize < 0L) |
715 |
< |
throw new IllegalArgumentException(BadSize); |
715 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
716 |
|
if (randomNumberOrigin >= randomNumberBound) |
717 |
< |
throw new IllegalArgumentException(BadRange); |
717 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
718 |
|
return StreamSupport.longStream |
719 |
|
(new RandomLongsSpliterator |
720 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
723 |
|
|
724 |
|
/** |
725 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
726 |
< |
* long} values, each conforming to the given origin and bound. |
726 |
> |
* long} values from this generator and/or one split from it; each value |
727 |
> |
* conforms to the given origin (inclusive) and bound (exclusive). |
728 |
|
* |
729 |
|
* @implNote This method is implemented to be equivalent to {@code |
730 |
|
* longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}. |
731 |
|
* |
732 |
< |
* @param randomNumberOrigin the origin of each random value |
733 |
< |
* @param randomNumberBound the bound of each random value |
732 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
733 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
734 |
|
* @return a stream of pseudorandom {@code long} values, |
735 |
< |
* each with the given origin and bound |
735 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
736 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
737 |
|
* is greater than or equal to {@code randomNumberBound} |
738 |
|
*/ |
739 |
|
public LongStream longs(long randomNumberOrigin, long randomNumberBound) { |
740 |
|
if (randomNumberOrigin >= randomNumberBound) |
741 |
< |
throw new IllegalArgumentException(BadRange); |
741 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
742 |
|
return StreamSupport.longStream |
743 |
|
(new RandomLongsSpliterator |
744 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
747 |
|
|
748 |
|
/** |
749 |
|
* Returns a stream producing the given {@code streamSize} number of |
750 |
< |
* pseudorandom {@code double} values, each between zero |
751 |
< |
* (inclusive) and one (exclusive). |
750 |
> |
* pseudorandom {@code double} values from this generator and/or one split |
751 |
> |
* from it; each value is between zero (inclusive) and one (exclusive). |
752 |
|
* |
753 |
|
* @param streamSize the number of values to generate |
754 |
|
* @return a stream of {@code double} values |
757 |
|
*/ |
758 |
|
public DoubleStream doubles(long streamSize) { |
759 |
|
if (streamSize < 0L) |
760 |
< |
throw new IllegalArgumentException(BadSize); |
760 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
761 |
|
return StreamSupport.doubleStream |
762 |
|
(new RandomDoublesSpliterator |
763 |
|
(this, 0L, streamSize, Double.MAX_VALUE, 0.0), |
766 |
|
|
767 |
|
/** |
768 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
769 |
< |
* double} values, each between zero (inclusive) and one |
770 |
< |
* (exclusive). |
769 |
> |
* double} values from this generator and/or one split from it; each value |
770 |
> |
* is between zero (inclusive) and one (exclusive). |
771 |
|
* |
772 |
|
* @implNote This method is implemented to be equivalent to {@code |
773 |
|
* doubles(Long.MAX_VALUE)}. |
783 |
|
|
784 |
|
/** |
785 |
|
* Returns a stream producing the given {@code streamSize} number of |
786 |
< |
* pseudorandom {@code double} values, each conforming to the |
787 |
< |
* given origin and bound. |
786 |
> |
* pseudorandom {@code double} values from this generator and/or one split |
787 |
> |
* from it; each value conforms to the given origin (inclusive) and bound |
788 |
> |
* (exclusive). |
789 |
|
* |
790 |
|
* @param streamSize the number of values to generate |
791 |
< |
* @param randomNumberOrigin the origin of each random value |
792 |
< |
* @param randomNumberBound the bound of each random value |
791 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
792 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
793 |
|
* @return a stream of pseudorandom {@code double} values, |
794 |
< |
* each with the given origin and bound |
794 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
795 |
|
* @throws IllegalArgumentException if {@code streamSize} is |
796 |
< |
* less than zero |
796 |
> |
* less than zero |
797 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
798 |
|
* is greater than or equal to {@code randomNumberBound} |
799 |
|
*/ |
800 |
|
public DoubleStream doubles(long streamSize, double randomNumberOrigin, |
801 |
|
double randomNumberBound) { |
802 |
|
if (streamSize < 0L) |
803 |
< |
throw new IllegalArgumentException(BadSize); |
803 |
> |
throw new IllegalArgumentException(BAD_SIZE); |
804 |
|
if (!(randomNumberOrigin < randomNumberBound)) |
805 |
< |
throw new IllegalArgumentException(BadRange); |
805 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
806 |
|
return StreamSupport.doubleStream |
807 |
|
(new RandomDoublesSpliterator |
808 |
|
(this, 0L, streamSize, randomNumberOrigin, randomNumberBound), |
811 |
|
|
812 |
|
/** |
813 |
|
* Returns an effectively unlimited stream of pseudorandom {@code |
814 |
< |
* double} values, each conforming to the given origin and bound. |
814 |
> |
* double} values from this generator and/or one split from it; each value |
815 |
> |
* conforms to the given origin (inclusive) and bound (exclusive). |
816 |
|
* |
817 |
|
* @implNote This method is implemented to be equivalent to {@code |
818 |
|
* doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}. |
819 |
|
* |
820 |
< |
* @param randomNumberOrigin the origin of each random value |
821 |
< |
* @param randomNumberBound the bound of each random value |
820 |
> |
* @param randomNumberOrigin the origin (inclusive) of each random value |
821 |
> |
* @param randomNumberBound the bound (exclusive) of each random value |
822 |
|
* @return a stream of pseudorandom {@code double} values, |
823 |
< |
* each with the given origin and bound |
823 |
> |
* each with the given origin (inclusive) and bound (exclusive) |
824 |
|
* @throws IllegalArgumentException if {@code randomNumberOrigin} |
825 |
|
* is greater than or equal to {@code randomNumberBound} |
826 |
|
*/ |
827 |
|
public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) { |
828 |
|
if (!(randomNumberOrigin < randomNumberBound)) |
829 |
< |
throw new IllegalArgumentException(BadRange); |
829 |
> |
throw new IllegalArgumentException(BAD_RANGE); |
830 |
|
return StreamSupport.doubleStream |
831 |
|
(new RandomDoublesSpliterator |
832 |
|
(this, 0L, Long.MAX_VALUE, randomNumberOrigin, randomNumberBound), |
841 |
|
* approach. The long and double versions of this class are |
842 |
|
* identical except for types. |
843 |
|
*/ |
844 |
< |
static final class RandomIntsSpliterator implements Spliterator.OfInt { |
844 |
> |
private static final class RandomIntsSpliterator |
845 |
> |
implements Spliterator.OfInt { |
846 |
|
final SplittableRandom rng; |
847 |
|
long index; |
848 |
|
final long fence; |
897 |
|
/** |
898 |
|
* Spliterator for long streams. |
899 |
|
*/ |
900 |
< |
static final class RandomLongsSpliterator implements Spliterator.OfLong { |
900 |
> |
private static final class RandomLongsSpliterator |
901 |
> |
implements Spliterator.OfLong { |
902 |
|
final SplittableRandom rng; |
903 |
|
long index; |
904 |
|
final long fence; |
954 |
|
/** |
955 |
|
* Spliterator for double streams. |
956 |
|
*/ |
957 |
< |
static final class RandomDoublesSpliterator implements Spliterator.OfDouble { |
957 |
> |
private static final class RandomDoublesSpliterator |
958 |
> |
implements Spliterator.OfDouble { |
959 |
|
final SplittableRandom rng; |
960 |
|
long index; |
961 |
|
final long fence; |