|
57547
|
1 |
/*
|
|
|
2 |
* Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
|
|
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
|
4 |
*
|
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
|
|
10 |
*
|
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
|
15 |
* accompanied this code).
|
|
|
16 |
*
|
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
20 |
*
|
|
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
|
|
23 |
* questions.
|
|
|
24 |
*/
|
|
|
25 |
|
|
|
26 |
package java.util.random;
|
|
|
27 |
|
|
|
28 |
import java.math.BigInteger;
|
|
57671
|
29 |
import java.util.Objects;
|
|
57547
|
30 |
import java.util.stream.DoubleStream;
|
|
|
31 |
import java.util.stream.IntStream;
|
|
|
32 |
import java.util.stream.LongStream;
|
|
|
33 |
import java.util.stream.Stream;
|
|
|
34 |
|
|
|
35 |
/**
|
|
57684
|
36 |
* The {@link RandomGenerator} interface is designed to provide a common protocol for objects that
|
|
59080
|
37 |
* generate random or (more typically) pseudorandom sequences of numbers (or Boolean values).
|
|
|
38 |
* Such a sequence may be obtained by either repeatedly invoking a method that returns a single
|
|
57547
|
39 |
* (pseudo)randomly chosen value, or by invoking a method that returns a stream of (pseudo)randomly
|
|
|
40 |
* chosen values.
|
|
|
41 |
* <p>
|
|
|
42 |
* Ideally, given an implicitly or explicitly specified range of values, each value would be chosen
|
|
|
43 |
* independently and uniformly from that range. In practice, one may have to settle for some
|
|
|
44 |
* approximation to independence and uniformity.
|
|
|
45 |
* <p>
|
|
|
46 |
* In the case of {@code int}, {@code long}, and {@link Boolean} values, if there is no explicit
|
|
|
47 |
* specification of range, then the range includes all possible values of the type. In the case of
|
|
|
48 |
* {@code float} and {@code double} values, a value is always chosen from the set of
|
|
|
49 |
* 2<sup><i>w</i></sup> values between 0.0 (inclusive) and 1.0 (exclusive), where <i>w</i> is 23 for
|
|
|
50 |
* {@code float} values and 52 for {@code double} values, such that adjacent values differ by
|
|
|
51 |
* 2<sup>−<i>w</i></sup>; if an explicit range is specified, then the chosen number is
|
|
|
52 |
* computationally scaled and translated so as to appear to have been chosen from that range.
|
|
|
53 |
* <p>
|
|
|
54 |
* Each method that returns a stream produces a stream of values each of which is chosen in the same
|
|
|
55 |
* manner as for a method that returns a single (pseudo)randomly chosen value. For example, if
|
|
57684
|
56 |
* {@code r} implements {@link RandomGenerator}, then the method call {@code r.ints(100)} returns a
|
|
|
57 |
* stream of 100 {@code int} values. These are not necessarily the exact same values that would
|
|
|
58 |
* have been returned if instead {@code r.nextInt()} had been called 100 times; all that is
|
|
57547
|
59 |
* guaranteed is that each value in the stream is chosen in a similar (pseudo)random manner from the
|
|
|
60 |
* same range.
|
|
|
61 |
* <p>
|
|
59080
|
62 |
* Every object that implements the {@link RandomNumberGenerator} interface by using a
|
|
|
63 |
* pseudorandom algorithm is assumed to contain a finite amount of state. Using such an object to
|
|
|
64 |
* generate a pseudorandomly chosen value alters its state by computing a new state as a function
|
|
|
65 |
* of the current state, without reference to any information other than the current state.
|
|
|
66 |
* The number of distinct possible states of such an object is called its <i>period</i>.
|
|
|
67 |
* (Some implementations of the {@link RandomNumberGenerator} interface may be truly random
|
|
|
68 |
* rather than pseudorandom, for example relying on the statistical behavior of a physical
|
|
|
69 |
* object to derive chosen values. Such implementations do not have a fixed period.)
|
|
57547
|
70 |
* <p>
|
|
57684
|
71 |
* As a rule, objects that implement the {@link RandomGenerator} interface need not be thread-safe.
|
|
|
72 |
* It is recommended that multithreaded applications use either {@link ThreadLocalRandom} or
|
|
|
73 |
* (preferably) pseudorandom number generators that implement the {@link SplittableGenerator} or
|
|
|
74 |
* {@link JumpableGenerator} interface.
|
|
57547
|
75 |
* <p>
|
|
|
76 |
* To implement this interface, a class only needs to provide concrete definitions for the methods
|
|
|
77 |
* {@code nextLong()} and {@code period()}. Default implementations are provided for all other
|
|
|
78 |
* methods (but it may be desirable to override some of them, especially {@code nextInt()} if the
|
|
59080
|
79 |
* underlying algorithm is {@code int}-based). Moreover, it may be preferable instead to implement
|
|
|
80 |
* a more specialized interface such as {@link JumpableGenerator} or {@link LeapableGenerator},
|
|
|
81 |
* or to extend an abstract implementation-support class such as {@link AbstractSplittableGenerator}
|
|
|
82 |
* or {@link AbstractArbitrarilyJumpableGenerator}.
|
|
57547
|
83 |
* <p>
|
|
|
84 |
* Objects that implement {@link RandomGenerator} are typically not cryptographically secure.
|
|
|
85 |
* Consider instead using {@link java.security.SecureRandom} to get a cryptographically secure
|
|
|
86 |
* pseudorandom number generator for use by security-sensitive applications. Note, however, that
|
|
57684
|
87 |
* {@code java.security.SecureRandom} does implement the {@link RandomGenerator} interface, so that
|
|
|
88 |
* instances of {@code java.security.SecureRandom} may be used interchangeably with other types of
|
|
|
89 |
* pseudorandom generators in applications that do not require a secure generator.
|
|
57547
|
90 |
*
|
|
|
91 |
* @since 14
|
|
|
92 |
*/
|
|
|
93 |
public interface RandomGenerator {
|
|
|
94 |
|
|
|
95 |
/**
|
|
59080
|
96 |
* Supported random number Algorithms.
|
|
57671
|
97 |
*/
|
|
|
98 |
public enum Algorithm {
|
|
|
99 |
/**
|
|
|
100 |
* L32X64MixRandom algorithm
|
|
|
101 |
*/
|
|
|
102 |
L32X64MixRandom("L32X64MixRandom"),
|
|
|
103 |
/**
|
|
|
104 |
* L64X128MixRandom algorithm
|
|
|
105 |
*/
|
|
|
106 |
L64X128MixRandom("L64X128MixRandom"),
|
|
|
107 |
/**
|
|
59080
|
108 |
* L64X128StarStarRandom algorithm
|
|
57671
|
109 |
*/
|
|
59080
|
110 |
L64X128StarStarRandom("L64X128StarStarRandom"),
|
|
|
111 |
/**
|
|
|
112 |
* L64X128PlusPlusRandom algorithm
|
|
|
113 |
*/
|
|
|
114 |
L64X128PlusPlusRandom("L64X128PlusPlusRandom"),
|
|
57671
|
115 |
/**
|
|
|
116 |
* L64X256MixRandom algorithm
|
|
|
117 |
*/
|
|
|
118 |
L64X256MixRandom("L64X256MixRandom"),
|
|
|
119 |
/**
|
|
59080
|
120 |
* L64X1024MixRandom algorithm
|
|
|
121 |
*/
|
|
|
122 |
L64X1024MixRandom("L64X1024MixRandom"),
|
|
|
123 |
/**
|
|
|
124 |
* L128X128MixRandom algorithm
|
|
57671
|
125 |
*/
|
|
59080
|
126 |
L128X128MixRandom("L128X128MixRandom"),
|
|
|
127 |
/**
|
|
|
128 |
* L128X128StarStarRandom algorithm
|
|
|
129 |
*/
|
|
|
130 |
L128X128StarStarRandom("L128X128StarStarRandom"),
|
|
|
131 |
/**
|
|
|
132 |
* L128X128PlusPlusRandom algorithm
|
|
|
133 |
*/
|
|
|
134 |
L128X128PlusPlusRandom("L128X128PlusPlusRandom"),
|
|
57671
|
135 |
/**
|
|
|
136 |
* L128X256MixRandom algorithm
|
|
|
137 |
*/
|
|
|
138 |
L128X256MixRandom("L128X256MixRandom"),
|
|
|
139 |
/**
|
|
59080
|
140 |
* L128X1024MixRandom algorithm
|
|
|
141 |
*/
|
|
|
142 |
L128X1024MixRandom("L128X1024MixRandom"),
|
|
|
143 |
/**
|
|
57671
|
144 |
* MRG32k3a algorithm
|
|
|
145 |
*/
|
|
|
146 |
MRG32k3a("MRG32k3a"),
|
|
|
147 |
/**
|
|
57940
|
148 |
* Legacy Random algorithm
|
|
|
149 |
*/
|
|
|
150 |
@Deprecated
|
|
|
151 |
Random("Random"),
|
|
|
152 |
/**
|
|
|
153 |
* Legacy SecureRandom algorithm
|
|
|
154 |
*/
|
|
|
155 |
@Deprecated
|
|
|
156 |
SecureRandom("SecureRandom"),
|
|
|
157 |
/**
|
|
59080
|
158 |
* Xoroshiro128PlusPlus algorithm
|
|
57671
|
159 |
*/
|
|
59080
|
160 |
Xoroshiro128PlusPlus("Xoroshiro128PlusPlus"),
|
|
57671
|
161 |
/**
|
|
|
162 |
* Xoroshiro128StarStar algorithm
|
|
|
163 |
*/
|
|
|
164 |
Xoroshiro128StarStar("Xoroshiro128StarStar"),
|
|
|
165 |
/**
|
|
|
166 |
* Xoshiro256StarStar algorithm
|
|
|
167 |
*/
|
|
|
168 |
Xoshiro256StarStar("Xoshiro256StarStar");
|
|
|
169 |
|
|
|
170 |
private String name;
|
|
|
171 |
|
|
57684
|
172 |
private Algorithm(String name) {
|
|
57671
|
173 |
this.name = name;
|
|
|
174 |
}
|
|
|
175 |
|
|
|
176 |
public String toString() {
|
|
|
177 |
return name;
|
|
|
178 |
}
|
|
57684
|
179 |
|
|
|
180 |
/**
|
|
|
181 |
* Returns an instance of {@link RandomGenerator} that utilizes this algorithm.
|
|
|
182 |
*
|
|
|
183 |
* @return An instance of {@link RandomGenerator}
|
|
|
184 |
*/
|
|
|
185 |
public RandomGenerator instance() {
|
|
|
186 |
return RandomGeneratorFactory.of(name, RandomGenerator.class);
|
|
|
187 |
}
|
|
|
188 |
|
|
|
189 |
/**
|
|
|
190 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
191 |
* of {@link RandomGenerator} that utilizes this algorithm.
|
|
|
192 |
*
|
|
|
193 |
* @return {@link RandomGeneratorFactory} of {@link RandomGenerator}
|
|
|
194 |
*/
|
|
|
195 |
public RandomGeneratorFactory<RandomGenerator> factory() {
|
|
|
196 |
return RandomGeneratorFactory.factoryOf(name, RandomGenerator.class);
|
|
|
197 |
}
|
|
57671
|
198 |
}
|
|
|
199 |
|
|
|
200 |
/**
|
|
|
201 |
* Returns an instance of {@link RandomGenerator} that utilizes the
|
|
|
202 |
* {@code name} algorithm.
|
|
|
203 |
*
|
|
|
204 |
* @param name Name of random number generator algorithm
|
|
|
205 |
*
|
|
|
206 |
* @return An instance of {@link RandomGenerator}
|
|
|
207 |
*/
|
|
|
208 |
public static RandomGenerator of(String name) {
|
|
|
209 |
Objects.requireNonNull(name);
|
|
|
210 |
return RandomGeneratorFactory.of(name, RandomGenerator.class);
|
|
|
211 |
}
|
|
|
212 |
|
|
|
213 |
/**
|
|
|
214 |
* Returns an instance of {@link RandomGenerator} that utilizes the
|
|
|
215 |
* specified {@code algorithm}.
|
|
|
216 |
*
|
|
|
217 |
* @param algorithm Random number generator algorithm
|
|
|
218 |
*
|
|
|
219 |
* @return An instance of {@link RandomGenerator}
|
|
|
220 |
*/
|
|
|
221 |
public static RandomGenerator of(Algorithm algorithm) {
|
|
|
222 |
Objects.requireNonNull(algorithm);
|
|
|
223 |
return RandomGeneratorFactory.of(algorithm.toString(), RandomGenerator.class);
|
|
|
224 |
}
|
|
|
225 |
|
|
|
226 |
/**
|
|
|
227 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
228 |
* of {@link RandomGenerator} that utilizes the {@code name} algorithm.
|
|
|
229 |
*
|
|
|
230 |
* @param name Name of random number generator algorithm
|
|
|
231 |
*
|
|
57684
|
232 |
* @return {@link RandomGeneratorFactory} of {@link RandomGenerator}
|
|
57671
|
233 |
*/
|
|
|
234 |
public static RandomGeneratorFactory<RandomGenerator> factoryOf(String name) {
|
|
|
235 |
Objects.requireNonNull(name);
|
|
|
236 |
return RandomGeneratorFactory.factoryOf(name, RandomGenerator.class);
|
|
|
237 |
}
|
|
|
238 |
|
|
|
239 |
/**
|
|
|
240 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
241 |
* of {@link RandomGenerator} that utilizes the specified {@code algorithm}.
|
|
|
242 |
*
|
|
|
243 |
* @param algorithm Random number generator algorithm
|
|
|
244 |
*
|
|
57684
|
245 |
* @return {@link RandomGeneratorFactory} of {@link RandomGenerator}
|
|
57671
|
246 |
*/
|
|
|
247 |
public static RandomGeneratorFactory<RandomGenerator> factoryOf(Algorithm algorithm) {
|
|
|
248 |
Objects.requireNonNull(algorithm);
|
|
|
249 |
return RandomGeneratorFactory.factoryOf(algorithm.toString(), RandomGenerator.class);
|
|
|
250 |
}
|
|
|
251 |
|
|
|
252 |
/**
|
|
57547
|
253 |
* Returns an effectively unlimited stream of pseudorandomly chosen
|
|
|
254 |
* {@code double} values.
|
|
|
255 |
*
|
|
|
256 |
* @return a stream of pseudorandomly chosen {@code double} values
|
|
|
257 |
*
|
|
|
258 |
* @implNote It is permitted to implement this method in a manner
|
|
|
259 |
* equivalent to {@code doubles(Long.MAX_VALUE)}.
|
|
|
260 |
*
|
|
|
261 |
* @implNote The default implementation produces a sequential stream
|
|
59080
|
262 |
* that repeatedly calls {@code nextDouble()}.
|
|
57547
|
263 |
*/
|
|
|
264 |
default DoubleStream doubles() {
|
|
|
265 |
return DoubleStream.generate(this::nextDouble).sequential();
|
|
|
266 |
}
|
|
|
267 |
|
|
|
268 |
/**
|
|
|
269 |
* Returns an effectively unlimited stream of pseudorandomly chosen
|
|
|
270 |
* {@code double} values, where each value is between the specified
|
|
|
271 |
* origin (inclusive) and the specified bound (exclusive).
|
|
|
272 |
*
|
|
|
273 |
* @param randomNumberOrigin the least value that can be produced
|
|
|
274 |
* @param randomNumberBound the upper bound (exclusive) for each value produced
|
|
|
275 |
*
|
|
|
276 |
* @return a stream of pseudorandomly chosen {@code double} values, each between
|
|
|
277 |
* the specified origin (inclusive) and the specified bound (exclusive)
|
|
|
278 |
*
|
|
59080
|
279 |
* @throws IllegalArgumentException if {@code randomNumberOrigin} is not finite,
|
|
|
280 |
* or {@code randomNumberBound} is not finite, or {@code randomNumberOrigin}
|
|
57547
|
281 |
* is greater than or equal to {@code randomNumberBound}
|
|
|
282 |
*
|
|
59080
|
283 |
* @implNote It is permitted to implement this method in a manner equivalent to
|
|
57547
|
284 |
* {@code doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
|
|
|
285 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
286 |
* calls {@code nextDouble(randomNumberOrigin, randomNumberBound)}.
|
|
|
287 |
*/
|
|
|
288 |
default DoubleStream doubles(double randomNumberOrigin, double randomNumberBound) {
|
|
|
289 |
RandomSupport.checkRange(randomNumberOrigin, randomNumberBound);
|
|
|
290 |
return DoubleStream.generate(() -> nextDouble(randomNumberOrigin, randomNumberBound)).sequential();
|
|
|
291 |
}
|
|
|
292 |
|
|
|
293 |
/**
|
|
|
294 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
295 |
* pseudorandomly chosen {@code double} values.
|
|
|
296 |
*
|
|
|
297 |
* @param streamSize the number of values to generate
|
|
|
298 |
*
|
|
|
299 |
* @return a stream of pseudorandomly chosen {@code double} values
|
|
|
300 |
*
|
|
|
301 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
302 |
* less than zero
|
|
|
303 |
*
|
|
|
304 |
* @implNote The default implementation produces a sequential stream
|
|
|
305 |
* that repeatedly calls {@code nextDouble()}.
|
|
|
306 |
*/
|
|
|
307 |
default DoubleStream doubles(long streamSize) {
|
|
|
308 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
309 |
return doubles().limit(streamSize);
|
|
|
310 |
}
|
|
|
311 |
|
|
|
312 |
/**
|
|
|
313 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
314 |
* pseudorandomly chosen {@code double} values, where each value is between
|
|
|
315 |
* the specified origin (inclusive) and the specified bound (exclusive).
|
|
|
316 |
*
|
|
|
317 |
* @param streamSize the number of values to generate
|
|
|
318 |
* @param randomNumberOrigin the least value that can be produced
|
|
|
319 |
* @param randomNumberBound the upper bound (exclusive) for each value produced
|
|
|
320 |
*
|
|
|
321 |
* @return a stream of pseudorandomly chosen {@code double} values, each between
|
|
|
322 |
* the specified origin (inclusive) and the specified bound (exclusive)
|
|
|
323 |
*
|
|
59080
|
324 |
* @throws IllegalArgumentException if {@code streamSize} is less than zero,
|
|
|
325 |
* or {@code randomNumberOrigin} is not finite,
|
|
|
326 |
* or {@code randomNumberBound} is not finite, or {@code randomNumberOrigin}
|
|
57547
|
327 |
* is greater than or equal to {@code randomNumberBound}
|
|
|
328 |
*
|
|
59080
|
329 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
330 |
* calls {@code nextDouble(randomNumberOrigin, randomNumberBound)}.
|
|
57547
|
331 |
*/
|
|
|
332 |
default DoubleStream doubles(long streamSize, double randomNumberOrigin,
|
|
59080
|
333 |
double randomNumberBound) {
|
|
57547
|
334 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
335 |
RandomSupport.checkRange(randomNumberOrigin, randomNumberBound);
|
|
|
336 |
return doubles(randomNumberOrigin, randomNumberBound).limit(streamSize);
|
|
|
337 |
}
|
|
|
338 |
|
|
|
339 |
/**
|
|
|
340 |
* Returns an effectively unlimited stream of pseudorandomly chosen
|
|
|
341 |
* {@code int} values.
|
|
|
342 |
*
|
|
|
343 |
* @return a stream of pseudorandomly chosen {@code int} values
|
|
|
344 |
*
|
|
|
345 |
* @implNote It is permitted to implement this method in a manner
|
|
59080
|
346 |
* equivalent to {@code ints(Long.MAX_VALUE)}.
|
|
57547
|
347 |
* @implNote The default implementation produces a sequential stream
|
|
59080
|
348 |
* that repeatedly calls {@code nextInt()}.
|
|
57547
|
349 |
*/
|
|
|
350 |
default IntStream ints() {
|
|
|
351 |
return IntStream.generate(this::nextInt).sequential();
|
|
|
352 |
}
|
|
|
353 |
|
|
|
354 |
/**
|
|
|
355 |
* Returns an effectively unlimited stream of pseudorandomly chosen
|
|
|
356 |
* {@code int} values, where each value is between the specified
|
|
|
357 |
* origin (inclusive) and the specified bound (exclusive).
|
|
|
358 |
*
|
|
|
359 |
* @param randomNumberOrigin the least value that can be produced
|
|
|
360 |
* @param randomNumberBound the upper bound (exclusive) for each value produced
|
|
|
361 |
*
|
|
|
362 |
* @return a stream of pseudorandomly chosen {@code int} values, each between
|
|
|
363 |
* the specified origin (inclusive) and the specified bound (exclusive)
|
|
|
364 |
*
|
|
|
365 |
* @throws IllegalArgumentException if {@code randomNumberOrigin}
|
|
|
366 |
* is greater than or equal to {@code randomNumberBound}
|
|
|
367 |
*
|
|
|
368 |
* @implNote It is permitted to implement this method in a manner equivalent to
|
|
|
369 |
* {@code ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
|
|
|
370 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
371 |
* calls {@code nextInt(randomNumberOrigin, randomNumberBound)}.
|
|
|
372 |
*/
|
|
|
373 |
default IntStream ints(int randomNumberOrigin, int randomNumberBound) {
|
|
|
374 |
RandomSupport.checkRange(randomNumberOrigin, randomNumberBound);
|
|
|
375 |
return IntStream.generate(() -> nextInt(randomNumberOrigin, randomNumberBound)).sequential();
|
|
|
376 |
}
|
|
|
377 |
|
|
|
378 |
/**
|
|
|
379 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
380 |
* pseudorandomly chosen {@code int} values.
|
|
|
381 |
*
|
|
|
382 |
* @param streamSize the number of values to generate
|
|
|
383 |
*
|
|
|
384 |
* @return a stream of pseudorandomly chosen {@code int} values
|
|
|
385 |
*
|
|
|
386 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
387 |
* less than zero
|
|
|
388 |
*
|
|
|
389 |
* @implNote The default implementation produces a sequential stream
|
|
|
390 |
* that repeatedly calls {@code nextInt()}.
|
|
|
391 |
*/
|
|
|
392 |
default IntStream ints(long streamSize) {
|
|
|
393 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
394 |
return ints().limit(streamSize);
|
|
|
395 |
}
|
|
|
396 |
|
|
|
397 |
/**
|
|
|
398 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
399 |
* pseudorandomly chosen {@code int} values, where each value is between
|
|
|
400 |
* the specified origin (inclusive) and the specified bound (exclusive).
|
|
|
401 |
*
|
|
|
402 |
* @param streamSize the number of values to generate
|
|
|
403 |
* @param randomNumberOrigin the least value that can be produced
|
|
|
404 |
* @param randomNumberBound the upper bound (exclusive) for each value produced
|
|
|
405 |
*
|
|
|
406 |
* @return a stream of pseudorandomly chosen {@code int} values, each between
|
|
|
407 |
* the specified origin (inclusive) and the specified bound (exclusive)
|
|
|
408 |
*
|
|
|
409 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
410 |
* less than zero, or {@code randomNumberOrigin}
|
|
|
411 |
* is greater than or equal to {@code randomNumberBound}
|
|
|
412 |
*
|
|
|
413 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
414 |
* calls {@code nextInt(randomNumberOrigin, randomNumberBound)}.
|
|
|
415 |
*/
|
|
|
416 |
default IntStream ints(long streamSize, int randomNumberOrigin,
|
|
59080
|
417 |
int randomNumberBound) {
|
|
57547
|
418 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
419 |
RandomSupport.checkRange(randomNumberOrigin, randomNumberBound);
|
|
|
420 |
return ints(randomNumberOrigin, randomNumberBound).limit(streamSize);
|
|
|
421 |
}
|
|
|
422 |
|
|
|
423 |
/**
|
|
|
424 |
* Returns an effectively unlimited stream of pseudorandomly chosen
|
|
|
425 |
* {@code long} values.
|
|
|
426 |
*
|
|
|
427 |
* @return a stream of pseudorandomly chosen {@code long} values
|
|
|
428 |
*
|
|
|
429 |
* @implNote It is permitted to implement this method in a manner
|
|
|
430 |
* equivalent to {@code longs(Long.MAX_VALUE)}.
|
|
|
431 |
* @implNote The default implementation produces a sequential stream
|
|
|
432 |
* that repeatedly calls {@code nextLong()}.
|
|
|
433 |
*/
|
|
|
434 |
default LongStream longs() {
|
|
|
435 |
return LongStream.generate(this::nextLong).sequential();
|
|
|
436 |
}
|
|
|
437 |
|
|
|
438 |
/**
|
|
|
439 |
* Returns an effectively unlimited stream of pseudorandomly chosen
|
|
|
440 |
* {@code long} values, where each value is between the specified
|
|
|
441 |
* origin (inclusive) and the specified bound (exclusive).
|
|
|
442 |
*
|
|
|
443 |
* @param randomNumberOrigin the least value that can be produced
|
|
|
444 |
* @param randomNumberBound the upper bound (exclusive) for each value produced
|
|
|
445 |
*
|
|
|
446 |
* @return a stream of pseudorandomly chosen {@code long} values, each between
|
|
|
447 |
* the specified origin (inclusive) and the specified bound (exclusive)
|
|
|
448 |
*
|
|
|
449 |
* @throws IllegalArgumentException if {@code randomNumberOrigin}
|
|
|
450 |
* is greater than or equal to {@code randomNumberBound}
|
|
|
451 |
*
|
|
59080
|
452 |
* @implNote It is permitted to implement this method in a manner equivalent to
|
|
|
453 |
* {@code longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)}.
|
|
57547
|
454 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
455 |
* calls {@code nextLong(randomNumberOrigin, randomNumberBound)}.
|
|
|
456 |
*/
|
|
|
457 |
default LongStream longs(long randomNumberOrigin, long randomNumberBound) {
|
|
|
458 |
RandomSupport.checkRange(randomNumberOrigin, randomNumberBound);
|
|
|
459 |
return LongStream.generate(() -> nextLong(randomNumberOrigin, randomNumberBound)).sequential();
|
|
|
460 |
}
|
|
|
461 |
|
|
|
462 |
/**
|
|
|
463 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
464 |
* pseudorandomly chosen {@code long} values.
|
|
|
465 |
*
|
|
|
466 |
* @param streamSize the number of values to generate
|
|
|
467 |
*
|
|
|
468 |
* @return a stream of pseudorandomly chosen {@code long} values
|
|
|
469 |
*
|
|
|
470 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
471 |
* less than zero
|
|
|
472 |
*
|
|
|
473 |
* @implNote The default implementation produces a sequential stream
|
|
|
474 |
* that repeatedly calls {@code nextLong()}.
|
|
|
475 |
*/
|
|
|
476 |
default LongStream longs(long streamSize) {
|
|
|
477 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
478 |
return longs().limit(streamSize);
|
|
|
479 |
}
|
|
|
480 |
|
|
|
481 |
/**
|
|
|
482 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
483 |
* pseudorandomly chosen {@code long} values, where each value is between
|
|
|
484 |
* the specified origin (inclusive) and the specified bound (exclusive).
|
|
|
485 |
*
|
|
|
486 |
* @param streamSize the number of values to generate
|
|
|
487 |
* @param randomNumberOrigin the least value that can be produced
|
|
|
488 |
* @param randomNumberBound the upper bound (exclusive) for each value produced
|
|
|
489 |
*
|
|
|
490 |
* @return a stream of pseudorandomly chosen {@code long} values, each between
|
|
|
491 |
* the specified origin (inclusive) and the specified bound (exclusive)
|
|
|
492 |
*
|
|
|
493 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
494 |
* less than zero, or {@code randomNumberOrigin}
|
|
|
495 |
* is greater than or equal to {@code randomNumberBound}
|
|
|
496 |
*
|
|
|
497 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
498 |
* calls {@code nextLong(randomNumberOrigin, randomNumberBound)}.
|
|
|
499 |
*/
|
|
|
500 |
default LongStream longs(long streamSize, long randomNumberOrigin,
|
|
59080
|
501 |
long randomNumberBound) {
|
|
57547
|
502 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
503 |
RandomSupport.checkRange(randomNumberOrigin, randomNumberBound);
|
|
|
504 |
return longs(randomNumberOrigin, randomNumberBound).limit(streamSize);
|
|
|
505 |
}
|
|
|
506 |
|
|
|
507 |
/**
|
|
|
508 |
* Returns a pseudorandomly chosen {@code boolean} value.
|
|
|
509 |
* <p>
|
|
59080
|
510 |
* The default implementation tests the high-order bit (sign bit) of a value produced by
|
|
|
511 |
* {@code nextInt()}, on the grounds that some algorithms for pseudorandom number generation
|
|
|
512 |
* produce values whose high-order bits have better statistical quality than the low-order bits.
|
|
57547
|
513 |
*
|
|
|
514 |
* @return a pseudorandomly chosen {@code boolean} value
|
|
|
515 |
*/
|
|
|
516 |
default boolean nextBoolean() {
|
|
|
517 |
return nextInt() < 0;
|
|
|
518 |
}
|
|
|
519 |
|
|
|
520 |
/**
|
|
|
521 |
* Returns a pseudorandom {@code float} value between zero (inclusive) and one (exclusive).
|
|
|
522 |
* <p>
|
|
|
523 |
* The default implementation uses the 24 high-order bits from a call to {@code nextInt()}.
|
|
|
524 |
*
|
|
|
525 |
* @return a pseudorandom {@code float} value between zero (inclusive) and one (exclusive)
|
|
|
526 |
*/
|
|
|
527 |
default float nextFloat() {
|
|
|
528 |
return (nextInt() >>> 8) * 0x1.0p-24f;
|
|
|
529 |
}
|
|
|
530 |
|
|
|
531 |
/**
|
|
|
532 |
* Returns a pseudorandomly chosen {@code float} value between zero
|
|
|
533 |
* (inclusive) and the specified bound (exclusive).
|
|
|
534 |
*
|
|
|
535 |
* @param bound the upper bound (exclusive) for the returned value.
|
|
|
536 |
* Must be positive and finite
|
|
|
537 |
*
|
|
|
538 |
* @return a pseudorandomly chosen {@code float} value between
|
|
|
539 |
* zero (inclusive) and the bound (exclusive)
|
|
|
540 |
*
|
|
|
541 |
* @throws IllegalArgumentException if {@code bound} is not
|
|
59080
|
542 |
* both positive and finite
|
|
57547
|
543 |
*
|
|
|
544 |
* @implNote The default implementation simply calls
|
|
59080
|
545 |
* {@code RandomSupport.checkBound(bound)} and then
|
|
|
546 |
* {@code RandomSupport.boundedNextFloat(this, bound)}.
|
|
57547
|
547 |
*/
|
|
|
548 |
default float nextFloat(float bound) {
|
|
|
549 |
RandomSupport.checkBound(bound);
|
|
|
550 |
return RandomSupport.boundedNextFloat(this, bound);
|
|
|
551 |
}
|
|
|
552 |
|
|
|
553 |
/**
|
|
|
554 |
* Returns a pseudorandomly chosen {@code float} value between the
|
|
|
555 |
* specified origin (inclusive) and the specified bound (exclusive).
|
|
|
556 |
*
|
|
|
557 |
* @param origin the least value that can be returned
|
|
|
558 |
* @param bound the upper bound (exclusive)
|
|
|
559 |
*
|
|
|
560 |
* @return a pseudorandomly chosen {@code float} value between the
|
|
|
561 |
* origin (inclusive) and the bound (exclusive)
|
|
|
562 |
*
|
|
59080
|
563 |
* @throws IllegalArgumentException if {@code origin} is not finite,
|
|
|
564 |
* or {@code bound} is not finite, or {@code origin}
|
|
|
565 |
* is greater than or equal to {@code bound}
|
|
57547
|
566 |
*
|
|
|
567 |
* @implNote The default implementation simply calls
|
|
|
568 |
* {@code RandomSupport.checkRange(origin, bound)} and then
|
|
59080
|
569 |
* {@code RandomSupport.boundedNextFloat(this, origin, bound)}.
|
|
57547
|
570 |
*/
|
|
|
571 |
default float nextFloat(float origin, float bound) {
|
|
|
572 |
RandomSupport.checkRange(origin, bound);
|
|
|
573 |
return RandomSupport.boundedNextFloat(this, origin, bound);
|
|
|
574 |
}
|
|
|
575 |
|
|
|
576 |
/**
|
|
|
577 |
* Returns a pseudorandom {@code double} value between zero (inclusive) and one (exclusive).
|
|
|
578 |
* <p>
|
|
|
579 |
* The default implementation uses the 53 high-order bits from a call to {@code nextLong()}.
|
|
|
580 |
*
|
|
|
581 |
* @return a pseudorandom {@code double} value between zero (inclusive) and one (exclusive)
|
|
|
582 |
*/
|
|
|
583 |
default double nextDouble() {
|
|
|
584 |
return (nextLong() >>> 11) * 0x1.0p-53;
|
|
|
585 |
}
|
|
|
586 |
|
|
|
587 |
/**
|
|
|
588 |
* Returns a pseudorandomly chosen {@code double} value between zero
|
|
|
589 |
* (inclusive) and the specified bound (exclusive).
|
|
|
590 |
*
|
|
|
591 |
* @param bound the upper bound (exclusive) for the returned value.
|
|
|
592 |
* Must be positive and finite
|
|
|
593 |
*
|
|
|
594 |
* @return a pseudorandomly chosen {@code double} value between
|
|
|
595 |
* zero (inclusive) and the bound (exclusive)
|
|
|
596 |
*
|
|
|
597 |
* @throws IllegalArgumentException if {@code bound} is not
|
|
59080
|
598 |
* both positive and finite
|
|
57547
|
599 |
*
|
|
|
600 |
* @implNote The default implementation simply calls
|
|
|
601 |
* {@code RandomSupport.checkBound(bound)} and then
|
|
|
602 |
* {@code RandomSupport.boundedNextDouble(this, bound)}.
|
|
|
603 |
*/
|
|
|
604 |
default double nextDouble(double bound) {
|
|
|
605 |
RandomSupport.checkBound(bound);
|
|
|
606 |
return RandomSupport.boundedNextDouble(this, bound);
|
|
|
607 |
}
|
|
|
608 |
|
|
|
609 |
/**
|
|
|
610 |
* Returns a pseudorandomly chosen {@code double} value between the
|
|
|
611 |
* specified origin (inclusive) and the specified bound (exclusive).
|
|
|
612 |
*
|
|
|
613 |
* @param origin the least value that can be returned
|
|
|
614 |
* @param bound the upper bound (exclusive) for the returned value
|
|
|
615 |
*
|
|
|
616 |
* @return a pseudorandomly chosen {@code double} value between the
|
|
|
617 |
* origin (inclusive) and the bound (exclusive)
|
|
|
618 |
*
|
|
59080
|
619 |
* @throws IllegalArgumentException if {@code origin} is not finite,
|
|
|
620 |
* or {@code bound} is not finite, or {@code origin}
|
|
|
621 |
* is greater than or equal to {@code bound}
|
|
57547
|
622 |
*
|
|
|
623 |
* @implNote The default implementation simply calls
|
|
|
624 |
* {@code RandomSupport.checkRange(origin, bound)} and then
|
|
|
625 |
* {@code RandomSupport.boundedNextDouble(this, origin, bound)}.
|
|
|
626 |
*/
|
|
|
627 |
default double nextDouble(double origin, double bound) {
|
|
|
628 |
RandomSupport.checkRange(origin, bound);
|
|
|
629 |
return RandomSupport.boundedNextDouble(this, origin, bound);
|
|
|
630 |
}
|
|
|
631 |
|
|
|
632 |
/**
|
|
|
633 |
* Returns a pseudorandomly chosen {@code int} value.
|
|
|
634 |
* <p>
|
|
|
635 |
* The default implementation uses the 32 high-order bits from a call to {@code nextLong()}.
|
|
|
636 |
*
|
|
|
637 |
* @return a pseudorandomly chosen {@code int} value
|
|
|
638 |
*/
|
|
|
639 |
default public int nextInt() {
|
|
|
640 |
return (int)(nextLong() >>> 32);
|
|
|
641 |
}
|
|
|
642 |
|
|
|
643 |
/**
|
|
|
644 |
* Returns a pseudorandomly chosen {@code int} value between
|
|
|
645 |
* zero (inclusive) and the specified bound (exclusive).
|
|
|
646 |
*
|
|
|
647 |
* @param bound the upper bound (exclusive) for the returned value. Must be positive.
|
|
|
648 |
*
|
|
|
649 |
* @return a pseudorandomly chosen {@code int} value between
|
|
|
650 |
* zero (inclusive) and the bound (exclusive)
|
|
|
651 |
*
|
|
|
652 |
* @throws IllegalArgumentException if {@code bound} is not positive
|
|
|
653 |
*
|
|
|
654 |
* @implNote The default implementation simply calls
|
|
|
655 |
* {@code RandomSupport.checkBound(bound)} and then
|
|
|
656 |
* {@code RandomSupport.boundedNextInt(this, bound)}.
|
|
|
657 |
*/
|
|
|
658 |
default int nextInt(int bound) {
|
|
|
659 |
RandomSupport.checkBound(bound);
|
|
|
660 |
return RandomSupport.boundedNextInt(this, bound);
|
|
|
661 |
}
|
|
|
662 |
|
|
|
663 |
/**
|
|
|
664 |
* Returns a pseudorandomly chosen {@code int} value between the
|
|
|
665 |
* specified origin (inclusive) and the specified bound (exclusive).
|
|
|
666 |
*
|
|
|
667 |
* @param origin the least value that can be returned
|
|
|
668 |
* @param bound the upper bound (exclusive) for the returned value
|
|
|
669 |
*
|
|
|
670 |
* @return a pseudorandomly chosen {@code int} value between the
|
|
|
671 |
* origin (inclusive) and the bound (exclusive)
|
|
|
672 |
*
|
|
|
673 |
* @throws IllegalArgumentException if {@code origin} is greater than
|
|
|
674 |
* or equal to {@code bound}
|
|
|
675 |
*
|
|
|
676 |
* @implNote The default implementation simply calls
|
|
|
677 |
* {@code RandomSupport.checkRange(origin, bound)} and then
|
|
|
678 |
* {@code RandomSupport.boundedNextInt(this, origin, bound)}.
|
|
|
679 |
*/
|
|
|
680 |
default int nextInt(int origin, int bound) {
|
|
|
681 |
RandomSupport.checkRange(origin, bound);
|
|
|
682 |
return RandomSupport.boundedNextInt(this, origin, bound);
|
|
|
683 |
}
|
|
|
684 |
|
|
|
685 |
/**
|
|
|
686 |
* Returns a pseudorandomly chosen {@code long} value.
|
|
|
687 |
*
|
|
|
688 |
* @return a pseudorandomly chosen {@code long} value
|
|
|
689 |
*/
|
|
|
690 |
long nextLong();
|
|
|
691 |
|
|
|
692 |
/**
|
|
|
693 |
* Returns a pseudorandomly chosen {@code long} value between
|
|
|
694 |
* zero (inclusive) and the specified bound (exclusive).
|
|
|
695 |
*
|
|
|
696 |
* @param bound the upper bound (exclusive) for the returned value. Must be positive.
|
|
|
697 |
*
|
|
|
698 |
* @return a pseudorandomly chosen {@code long} value between
|
|
|
699 |
* zero (inclusive) and the bound (exclusive)
|
|
|
700 |
*
|
|
|
701 |
* @throws IllegalArgumentException if {@code bound} is not positive
|
|
|
702 |
*
|
|
|
703 |
* @implNote The default implementation simply calls
|
|
|
704 |
* {@code RandomSupport.checkBound(bound)} and then
|
|
|
705 |
* {@code RandomSupport.boundedNextLong(this, bound)}.
|
|
|
706 |
*/
|
|
|
707 |
default long nextLong(long bound) {
|
|
|
708 |
RandomSupport.checkBound(bound);
|
|
|
709 |
return RandomSupport.boundedNextLong(this, bound);
|
|
|
710 |
}
|
|
|
711 |
|
|
|
712 |
/**
|
|
|
713 |
* Returns a pseudorandomly chosen {@code long} value between the
|
|
|
714 |
* specified origin (inclusive) and the specified bound (exclusive).
|
|
|
715 |
*
|
|
|
716 |
* @param origin the least value that can be returned
|
|
|
717 |
* @param bound the upper bound (exclusive) for the returned value
|
|
|
718 |
*
|
|
|
719 |
* @return a pseudorandomly chosen {@code long} value between the
|
|
|
720 |
* origin (inclusive) and the bound (exclusive)
|
|
|
721 |
*
|
|
|
722 |
* @throws IllegalArgumentException if {@code origin} is greater than
|
|
|
723 |
* or equal to {@code bound}
|
|
|
724 |
*
|
|
|
725 |
* @implNote The default implementation simply calls
|
|
|
726 |
* {@code RandomSupport.checkRange(origin, bound)} and then
|
|
|
727 |
* {@code RandomSupport.boundedNextInt(this, origin, bound)}.
|
|
|
728 |
*
|
|
|
729 |
*/
|
|
|
730 |
default long nextLong(long origin, long bound) {
|
|
|
731 |
RandomSupport.checkRange(origin, bound);
|
|
|
732 |
return RandomSupport.boundedNextLong(this, origin, bound);
|
|
|
733 |
}
|
|
|
734 |
|
|
|
735 |
/**
|
|
|
736 |
* Returns a {@code double} value pseudorandomly chosen from
|
|
|
737 |
* a Gaussian (normal) distribution whose mean is 0 and whose
|
|
|
738 |
* standard deviation is 1.
|
|
|
739 |
*
|
|
|
740 |
* @return a {@code double} value pseudorandomly chosen from a
|
|
|
741 |
* Gaussian distribution
|
|
|
742 |
*/
|
|
|
743 |
default double nextGaussian() {
|
|
|
744 |
return RandomSupport.computeNextGaussian(this);
|
|
|
745 |
}
|
|
|
746 |
|
|
|
747 |
/**
|
|
|
748 |
* Returns a {@code double} value pseudorandomly chosen from
|
|
|
749 |
* a Gaussian (normal) distribution with a mean and
|
|
|
750 |
* standard deviation specified by the arguments.
|
|
|
751 |
*
|
|
|
752 |
* @param mean the mean of the Gaussian distribution to be drawn from
|
|
|
753 |
* @param stddev the standard deviation (square root of the variance)
|
|
|
754 |
* of the Gaussian distribution to be drawn from
|
|
|
755 |
*
|
|
|
756 |
* @return a {@code double} value pseudorandomly chosen from the
|
|
|
757 |
* specified Gaussian distribution
|
|
|
758 |
*
|
|
|
759 |
* @throws IllegalArgumentException if {@code stddev} is negative
|
|
|
760 |
*/
|
|
|
761 |
default double nextGaussian(double mean, double stddev) {
|
|
|
762 |
if (stddev < 0.0) throw new IllegalArgumentException("standard deviation must be non-negative");
|
|
|
763 |
return mean + stddev * RandomSupport.computeNextGaussian(this);
|
|
|
764 |
}
|
|
|
765 |
|
|
|
766 |
/**
|
|
|
767 |
* Returns a nonnegative {@code double} value pseudorandomly chosen
|
|
|
768 |
* from an exponential distribution whose mean is 1.
|
|
|
769 |
*
|
|
|
770 |
* @return a nonnegative {@code double} value pseudorandomly chosen from an
|
|
|
771 |
* exponential distribution
|
|
|
772 |
*/
|
|
|
773 |
default double nextExponential() {
|
|
|
774 |
return RandomSupport.computeNextExponential(this);
|
|
|
775 |
}
|
|
|
776 |
|
|
|
777 |
/**
|
|
|
778 |
* Returns the period of this {@link RandomGenerator} object.
|
|
|
779 |
*
|
|
|
780 |
* @return a {@link BigInteger} whose value is the number of distinct possible states of this
|
|
|
781 |
* {@link RandomGenerator} object, or 0 if unknown, or negative if extremely
|
|
|
782 |
* large.
|
|
|
783 |
*/
|
|
|
784 |
BigInteger period();
|
|
|
785 |
|
|
|
786 |
/**
|
|
|
787 |
* The value (0) returned by the {@code period()} method if the period is unknown.
|
|
|
788 |
*/
|
|
|
789 |
static final BigInteger UNKNOWN_PERIOD = BigInteger.ZERO;
|
|
|
790 |
|
|
|
791 |
/**
|
|
|
792 |
* The (negative) value returned by the {@code period()} method if this generator
|
|
|
793 |
* has no period because it is truly random rather than just pseudorandom.
|
|
|
794 |
*/
|
|
|
795 |
static final BigInteger TRULY_RANDOM = BigInteger.valueOf(-1);
|
|
|
796 |
|
|
|
797 |
/**
|
|
|
798 |
* The (negative) value that may be returned by the {@code period()} method
|
|
|
799 |
* if this generator has a huge period (larger than 2**(2**16)).
|
|
|
800 |
*/
|
|
|
801 |
static final BigInteger HUGE_PERIOD = BigInteger.valueOf(-2);
|
|
|
802 |
|
|
|
803 |
/**
|
|
|
804 |
* The {@link StreamableGenerator} interface augments the {@link RandomGenerator} interface
|
|
|
805 |
* to provide methods that return streams of {@link RandomGenerator} objects.
|
|
|
806 |
* Ideally, such a stream of objects would have the property that the
|
|
|
807 |
* behavior of each object is statistically independent of all the others.
|
|
|
808 |
* In practice, one may have to settle for some approximation to this property.
|
|
|
809 |
*
|
|
|
810 |
* A generator that implements interface {@link SplittableGenerator}
|
|
|
811 |
* may choose to use its {@code splits} method to implement the {@code rngs}
|
|
|
812 |
* method required by this interface.
|
|
|
813 |
*
|
|
|
814 |
* A generator that implements interface {@link JumpableGenerator}
|
|
|
815 |
* may choose to use its {@code jumps} method to implement the {@code rngs}
|
|
|
816 |
* method required by this interface.
|
|
|
817 |
*
|
|
|
818 |
* A generator that implements interface {@link LeapableGenerator}
|
|
|
819 |
* may choose to use its {@code leaps} method to implement the {@code rngs}
|
|
|
820 |
* method required by this interface.
|
|
|
821 |
* <p>
|
|
|
822 |
* An implementation of the {@link StreamableGenerator} interface must provide
|
|
|
823 |
* concrete definitions for the methods {@code nextInt()}, {@code nextLong},
|
|
|
824 |
* {@code period()}, and {@code rngs()}.
|
|
|
825 |
* Default implementations are provided for all other methods.
|
|
|
826 |
* <p>
|
|
|
827 |
* Objects that implement {@link StreamableGenerator} are typically
|
|
|
828 |
* not cryptographically secure. Consider instead using
|
|
|
829 |
* {@link java.security.SecureRandom} to get a cryptographically
|
|
|
830 |
* secure pseudo-random number generator for use by
|
|
|
831 |
* security-sensitive applications.
|
|
|
832 |
*
|
|
|
833 |
* @since 14
|
|
|
834 |
*/
|
|
|
835 |
public interface StreamableGenerator extends RandomGenerator {
|
|
57671
|
836 |
|
|
|
837 |
/**
|
|
|
838 |
* Returns an instance of {@link StreamableGenerator} that utilizes the
|
|
|
839 |
* {@code name} algorithm.
|
|
|
840 |
*
|
|
|
841 |
* @param name Name of random number generator algorithm
|
|
|
842 |
*
|
|
|
843 |
* @return An instance of {@link StreamableGenerator}
|
|
|
844 |
*/
|
|
|
845 |
public static StreamableGenerator of(String name) {
|
|
|
846 |
Objects.requireNonNull(name);
|
|
|
847 |
return RandomGeneratorFactory.of(name, StreamableGenerator.class);
|
|
|
848 |
}
|
|
|
849 |
|
|
|
850 |
/**
|
|
|
851 |
* Returns an instance of {@link StreamableGenerator} that utilizes the
|
|
|
852 |
* specified {@code algorithm}.
|
|
|
853 |
*
|
|
|
854 |
* @param algorithm Random number generator algorithm
|
|
|
855 |
*
|
|
|
856 |
* @return An instance of {@link StreamableGenerator}
|
|
|
857 |
*/
|
|
|
858 |
public static StreamableGenerator of(Algorithm algorithm) {
|
|
|
859 |
Objects.requireNonNull(algorithm);
|
|
|
860 |
return RandomGeneratorFactory.of(algorithm.toString(), StreamableGenerator.class);
|
|
|
861 |
}
|
|
|
862 |
|
|
|
863 |
/**
|
|
|
864 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
865 |
* of {@link StreamableGenerator} that utilizes the {@code name} algorithm.
|
|
|
866 |
*
|
|
|
867 |
* @param name Name of random number generator algorithm
|
|
|
868 |
*
|
|
57684
|
869 |
* @return {@link RandomGeneratorFactory} of {@link StreamableGenerator}
|
|
57671
|
870 |
*/
|
|
|
871 |
public static RandomGeneratorFactory<StreamableGenerator> factoryOf(String name) {
|
|
|
872 |
Objects.requireNonNull(name);
|
|
|
873 |
return RandomGeneratorFactory.factoryOf(name, StreamableGenerator.class);
|
|
|
874 |
}
|
|
|
875 |
|
|
|
876 |
/**
|
|
|
877 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
878 |
* of {@link StreamableGenerator} that utilizes the specified {@code algorithm}.
|
|
|
879 |
*
|
|
|
880 |
* @param algorithm Random number generator algorithm
|
|
|
881 |
*
|
|
57684
|
882 |
* @return {@link RandomGeneratorFactory} of {@link StreamableGenerator}
|
|
57671
|
883 |
*/
|
|
|
884 |
public static RandomGeneratorFactory<StreamableGenerator> factoryOf(Algorithm algorithm) {
|
|
|
885 |
Objects.requireNonNull(algorithm);
|
|
|
886 |
return RandomGeneratorFactory.factoryOf(algorithm.toString(), StreamableGenerator.class);
|
|
|
887 |
}
|
|
|
888 |
|
|
57547
|
889 |
/**
|
|
|
890 |
* Returns an effectively unlimited stream of objects, each of
|
|
|
891 |
* which implements the {@link RandomGenerator} interface. Ideally the
|
|
|
892 |
* generators in the stream will appear to be statistically
|
|
|
893 |
* independent. The new generators should be of the same kind
|
|
|
894 |
* as this generator.
|
|
|
895 |
*
|
|
|
896 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
897 |
*
|
|
|
898 |
* @implNote It is permitted to implement this method in a manner
|
|
|
899 |
* equivalent to {@code rngs(Long.MAX_VALUE)}.
|
|
|
900 |
*/
|
|
|
901 |
Stream<RandomGenerator> rngs();
|
|
|
902 |
|
|
|
903 |
/**
|
|
|
904 |
* Returns an effectively unlimited stream of objects, each of
|
|
|
905 |
* which implements the {@link RandomGenerator} interface. Ideally the
|
|
|
906 |
* generators in the stream will appear to be statistically
|
|
|
907 |
* independent. The new generators should be of the same kind
|
|
|
908 |
* as this generator.
|
|
|
909 |
*
|
|
|
910 |
* @param streamSize the number of generators to generate
|
|
|
911 |
*
|
|
|
912 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
913 |
*
|
|
|
914 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
915 |
* less than zero
|
|
|
916 |
*
|
|
|
917 |
* @implNote The default implementation calls {@code rngs()} and
|
|
|
918 |
* then limits its length to {@code streamSize}.
|
|
|
919 |
*/
|
|
|
920 |
default Stream<RandomGenerator> rngs(long streamSize) {
|
|
|
921 |
RandomSupport.checkStreamSize(streamSize);
|
|
|
922 |
return rngs().limit(streamSize);
|
|
|
923 |
}
|
|
|
924 |
}
|
|
|
925 |
|
|
|
926 |
/**
|
|
|
927 |
* This interface is designed to provide a common protocol for objects
|
|
|
928 |
* that generate sequences of pseudorandom numbers (or Boolean values)
|
|
|
929 |
* and furthermore can be <i>split</i> into two objects (the original
|
|
|
930 |
* one and a new one) each of which obey that same protocol (and therefore
|
|
|
931 |
* can be recursively split indefinitely).
|
|
|
932 |
* <p>
|
|
|
933 |
* Ideally, all {@link SplittableGenerator} objects produced by recursive
|
|
|
934 |
* splitting from a single original {@link SplittableGenerator} object are
|
|
|
935 |
* statistically independent of one another and individually uniform.
|
|
|
936 |
* Therefore we would expect the set of values collectively generated
|
|
|
937 |
* by a set of such objects to have the same statistical properties as
|
|
|
938 |
* if the same quantity of values were generated by a single thread
|
|
|
939 |
* using a single {@link SplittableGenerator} object. In practice, one must
|
|
|
940 |
* settle for some approximation to independence and uniformity.
|
|
|
941 |
* <p>
|
|
|
942 |
* Methods are provided to perform a single splitting operation and
|
|
|
943 |
* also to produce a stream of generators split off from the original
|
|
|
944 |
* (by either iterative or recursive splitting, or a combination).
|
|
|
945 |
* <p>
|
|
|
946 |
* An implementation of the {@link SplittableGenerator} interface must provide
|
|
|
947 |
* concrete definitions for the methods {@code nextInt()}, {@code nextLong},
|
|
|
948 |
* {@code period()}, {@code split()}, {@code split(SplittableGenerator)},
|
|
|
949 |
* {@code splits()}, {@code splits(long)}, {@code splits(SplittableGenerator)},
|
|
|
950 |
* and {@code splits(long, SplittableGenerator)}. Perhaps the most convenient
|
|
|
951 |
* way to implement this interface is to extend the abstract class
|
|
|
952 |
* {@link AbstractSplittableGenerator}.
|
|
|
953 |
* <p>
|
|
|
954 |
* Objects that implement {@link SplittableGenerator} are
|
|
|
955 |
* typically not cryptographically secure. Consider instead using
|
|
|
956 |
* {@link java.security.SecureRandom} to get a cryptographically
|
|
|
957 |
* secure pseudo-random number generator for use by
|
|
|
958 |
* security-sensitive applications.
|
|
|
959 |
*
|
|
|
960 |
* @since 14
|
|
|
961 |
*/
|
|
|
962 |
public interface SplittableGenerator extends StreamableGenerator {
|
|
|
963 |
|
|
|
964 |
/**
|
|
57671
|
965 |
* Returns an instance of {@link SplittableGenerator} that utilizes the
|
|
|
966 |
* {@code name} algorithm.
|
|
|
967 |
*
|
|
|
968 |
* @param name Name of random number generator algorithm
|
|
|
969 |
*
|
|
|
970 |
* @return An instance of {@link SplittableGenerator}
|
|
|
971 |
*/
|
|
|
972 |
public static SplittableGenerator of(String name) {
|
|
|
973 |
Objects.requireNonNull(name);
|
|
|
974 |
return RandomGeneratorFactory.of(name, SplittableGenerator.class);
|
|
|
975 |
}
|
|
|
976 |
|
|
|
977 |
/**
|
|
|
978 |
* Returns an instance of {@link SplittableGenerator} that utilizes the
|
|
|
979 |
* specified {@code algorithm}.
|
|
|
980 |
*
|
|
|
981 |
* @param algorithm Random number generator algorithm
|
|
|
982 |
*
|
|
|
983 |
* @return An instance of {@link SplittableGenerator}
|
|
|
984 |
*/
|
|
|
985 |
public static SplittableGenerator of(Algorithm algorithm) {
|
|
|
986 |
Objects.requireNonNull(algorithm);
|
|
|
987 |
return RandomGeneratorFactory.of(algorithm.toString(), SplittableGenerator.class);
|
|
|
988 |
}
|
|
|
989 |
|
|
|
990 |
/**
|
|
|
991 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
992 |
* of {@link SplittableGenerator} that utilizes the {@code name} algorithm.
|
|
|
993 |
*
|
|
|
994 |
* @param name Name of random number generator algorithm
|
|
|
995 |
*
|
|
57684
|
996 |
* @return {@link RandomGeneratorFactory} of {@link SplittableGenerator}
|
|
57671
|
997 |
*/
|
|
|
998 |
public static RandomGeneratorFactory<SplittableGenerator> factoryOf(String name) {
|
|
|
999 |
Objects.requireNonNull(name);
|
|
|
1000 |
return RandomGeneratorFactory.factoryOf(name, SplittableGenerator.class);
|
|
|
1001 |
}
|
|
|
1002 |
|
|
|
1003 |
/**
|
|
|
1004 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1005 |
* of {@link SplittableGenerator} that utilizes the specified {@code algorithm}.
|
|
|
1006 |
*
|
|
|
1007 |
* @param algorithm Random number generator algorithm
|
|
|
1008 |
*
|
|
57684
|
1009 |
* @return {@link RandomGeneratorFactory} of {@link SplittableGenerator}
|
|
57671
|
1010 |
*/
|
|
|
1011 |
public static RandomGeneratorFactory<SplittableGenerator> factoryOf(Algorithm algorithm) {
|
|
|
1012 |
Objects.requireNonNull(algorithm);
|
|
|
1013 |
return RandomGeneratorFactory.factoryOf(algorithm.toString(), SplittableGenerator.class);
|
|
|
1014 |
}
|
|
|
1015 |
|
|
|
1016 |
/**
|
|
57547
|
1017 |
* Returns a new pseudorandom number generator, split off from
|
|
|
1018 |
* this one, that implements the {@link RandomGenerator} and {@link SplittableGenerator}
|
|
|
1019 |
* interfaces.
|
|
|
1020 |
*
|
|
|
1021 |
* This pseudorandom number generator may be used as a source of
|
|
|
1022 |
* pseudorandom bits used to initialize the state the new one.
|
|
|
1023 |
*
|
|
|
1024 |
* @return a new object that implements the {@link RandomGenerator} and
|
|
|
1025 |
* {@link SplittableGenerator} interfaces
|
|
|
1026 |
*/
|
|
|
1027 |
SplittableGenerator split();
|
|
|
1028 |
|
|
|
1029 |
/**
|
|
|
1030 |
* Returns a new pseudorandom number generator, split off from
|
|
|
1031 |
* this one, that implements the {@link RandomGenerator} and {@link SplittableGenerator}
|
|
|
1032 |
* interfaces.
|
|
|
1033 |
*
|
|
|
1034 |
* @param source a {@link SplittableGenerator} instance to be used instead
|
|
|
1035 |
* of this one as a source of pseudorandom bits used to
|
|
|
1036 |
* initialize the state of the new ones.
|
|
|
1037 |
*
|
|
|
1038 |
* @return an object that implements the {@link RandomGenerator} and
|
|
|
1039 |
* {@link SplittableGenerator} interfaces
|
|
|
1040 |
*/
|
|
|
1041 |
SplittableGenerator split(SplittableGenerator source);
|
|
|
1042 |
|
|
|
1043 |
/**
|
|
|
1044 |
* Returns an effectively unlimited stream of new pseudorandom
|
|
|
1045 |
* number generators, each of which implements the {@link SplittableGenerator}
|
|
|
1046 |
* interface.
|
|
|
1047 |
*
|
|
|
1048 |
* This pseudorandom number generator may be used as a source of
|
|
|
1049 |
* pseudorandom bits used to initialize the state the new ones.
|
|
|
1050 |
*
|
|
|
1051 |
* @implNote It is permitted to implement this method in a manner
|
|
|
1052 |
* equivalent to {@code splits(Long.MAX_VALUE)}.
|
|
|
1053 |
*
|
|
|
1054 |
* @return a stream of {@link SplittableGenerator} objects
|
|
|
1055 |
*/
|
|
|
1056 |
default Stream<SplittableGenerator> splits() {
|
|
|
1057 |
return this.splits(this);
|
|
|
1058 |
}
|
|
|
1059 |
|
|
|
1060 |
/**
|
|
|
1061 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
1062 |
* new pseudorandom number generators, each of which implements the
|
|
|
1063 |
* {@link SplittableGenerator} interface.
|
|
|
1064 |
*
|
|
|
1065 |
* This pseudorandom number generator may be used as a source of
|
|
|
1066 |
* pseudorandom bits used to initialize the state the new ones.
|
|
|
1067 |
*
|
|
|
1068 |
* @param streamSize the number of values to generate
|
|
|
1069 |
*
|
|
|
1070 |
* @return a stream of {@link SplittableGenerator} objects
|
|
|
1071 |
*
|
|
|
1072 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
1073 |
* less than zero
|
|
|
1074 |
*/
|
|
|
1075 |
Stream<SplittableGenerator> splits(long streamSize);
|
|
|
1076 |
|
|
|
1077 |
/**
|
|
|
1078 |
* Returns an effectively unlimited stream of new pseudorandom
|
|
|
1079 |
* number generators, each of which implements the {@link SplittableGenerator}
|
|
|
1080 |
* interface.
|
|
|
1081 |
*
|
|
|
1082 |
* @param source a {@link SplittableGenerator} instance to be used instead
|
|
|
1083 |
* of this one as a source of pseudorandom bits used to
|
|
|
1084 |
* initialize the state of the new ones.
|
|
|
1085 |
*
|
|
|
1086 |
* @return a stream of {@link SplittableGenerator} objects
|
|
|
1087 |
*
|
|
|
1088 |
* @implNote It is permitted to implement this method in a manner
|
|
|
1089 |
* equivalent to {@code splits(Long.MAX_VALUE, source)}.
|
|
|
1090 |
*/
|
|
|
1091 |
Stream<SplittableGenerator> splits(SplittableGenerator source);
|
|
|
1092 |
|
|
|
1093 |
/**
|
|
|
1094 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
1095 |
* new pseudorandom number generators, each of which implements the
|
|
|
1096 |
* {@link SplittableGenerator} interface.
|
|
|
1097 |
*
|
|
|
1098 |
* @param streamSize the number of values to generate
|
|
|
1099 |
* @param source a {@link SplittableGenerator} instance to be used instead
|
|
|
1100 |
* of this one as a source of pseudorandom bits used to
|
|
|
1101 |
* initialize the state of the new ones.
|
|
|
1102 |
*
|
|
|
1103 |
* @return a stream of {@link SplittableGenerator} objects
|
|
|
1104 |
*
|
|
|
1105 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
1106 |
* less than zero
|
|
|
1107 |
*/
|
|
|
1108 |
Stream<SplittableGenerator> splits(long streamSize, SplittableGenerator source);
|
|
|
1109 |
|
|
|
1110 |
/**
|
|
|
1111 |
* Returns an effectively unlimited stream of new pseudorandom
|
|
|
1112 |
* number generators, each of which implements the {@link RandomGenerator}
|
|
|
1113 |
* interface. Ideally the generators in the stream will appear
|
|
|
1114 |
* to be statistically independent.
|
|
|
1115 |
*
|
|
|
1116 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1117 |
*
|
|
|
1118 |
* @implNote The default implementation calls {@code splits()}.
|
|
|
1119 |
*/
|
|
|
1120 |
default Stream<RandomGenerator> rngs() {
|
|
|
1121 |
return this.splits().map(x -> (RandomGenerator)x);
|
|
|
1122 |
}
|
|
|
1123 |
|
|
|
1124 |
/**
|
|
|
1125 |
* Returns a stream producing the given {@code streamSize} number of
|
|
|
1126 |
* new pseudorandom number generators, each of which implements the
|
|
|
1127 |
* {@link RandomGenerator} interface. Ideally the generators in the stream will
|
|
|
1128 |
* appear to be statistically independent.
|
|
|
1129 |
*
|
|
|
1130 |
* @param streamSize the number of generators to generate
|
|
|
1131 |
*
|
|
|
1132 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1133 |
*
|
|
|
1134 |
* @throws IllegalArgumentException if {@code streamSize} is
|
|
|
1135 |
* less than zero
|
|
|
1136 |
*
|
|
|
1137 |
* @implNote The default implementation calls {@code splits(streamSize)}.
|
|
|
1138 |
*/
|
|
|
1139 |
default Stream<RandomGenerator> rngs(long streamSize) {
|
|
|
1140 |
return this.splits(streamSize).map(x -> (RandomGenerator)x);
|
|
|
1141 |
}
|
|
|
1142 |
}
|
|
|
1143 |
|
|
|
1144 |
/**
|
|
57684
|
1145 |
* This interface is designed to provide a common protocol for objects that generate
|
|
|
1146 |
* pseudorandom sequences of numbers (or Boolean values) and furthermore can easily <i>jump</i>
|
|
|
1147 |
* forward (by a fixed amount) to a distant point in the state cycle.
|
|
57547
|
1148 |
* <p>
|
|
57684
|
1149 |
* Ideally, all {@link JumpableGenerator} objects produced by iterative jumping from a single
|
|
|
1150 |
* original {@link JumpableGenerator} object are statistically independent of one another and
|
|
|
1151 |
* individually uniform. In practice, one must settle for some approximation to independence and
|
|
|
1152 |
* uniformity. In particular, a specific implementation may assume that each generator in a
|
|
|
1153 |
* stream produced by the {@code jumps} method is used to produce a number of values no larger
|
|
|
1154 |
* than either 2<sup>64</sup> or the square root of its period. Implementors are advised to use
|
|
|
1155 |
* algorithms whose period is at least 2<sup>127</sup>.
|
|
57547
|
1156 |
* <p>
|
|
|
1157 |
* Methods are provided to perform a single jump operation and also to produce a stream of
|
|
|
1158 |
* generators produced from the original by iterative copying and jumping of internal state. A
|
|
57684
|
1159 |
* typical strategy for a multithreaded application is to create a single {@link
|
|
|
1160 |
* JumpableGenerator} object, calls its {@code jumps} method exactly once, and then parcel out
|
|
|
1161 |
* generators from the resulting stream, one to each thread. It is generally not a good idea to
|
|
|
1162 |
* call {@code jump} on a generator that was itself produced by the {@code jumps} method,
|
|
|
1163 |
* because the result may be a generator identical to another generator already produce by that
|
|
|
1164 |
* call to the {@code jumps} method. For this reason, the return type of the {@code jumps}
|
|
|
1165 |
* method is {@code Stream<RandomGenerator>} rather than {@code Stream<JumpableGenerator>}, even
|
|
|
1166 |
* though the actual generator objects in that stream likely do also implement the {@link
|
|
|
1167 |
* JumpableGenerator} interface.
|
|
57547
|
1168 |
* <p>
|
|
57684
|
1169 |
* An implementation of the {@link JumpableGenerator} interface must provide concrete
|
|
|
1170 |
* definitions for the methods {@code nextInt()}, {@code nextLong}, {@code period()}, {@code
|
|
|
1171 |
* copy()}, {@code jump()}, and {@code defaultJumpDistance()}. Default implementations are
|
|
|
1172 |
* provided for all other methods.
|
|
57547
|
1173 |
* <p>
|
|
57684
|
1174 |
* Objects that implement {@link JumpableGenerator} are typically not cryptographically secure.
|
|
|
1175 |
* Consider instead using {@link java.security.SecureRandom} to get a cryptographically secure
|
|
|
1176 |
* pseudo-random number generator for use by security-sensitive applications.
|
|
57547
|
1177 |
*
|
|
|
1178 |
* @since 14
|
|
|
1179 |
*/
|
|
|
1180 |
public interface JumpableGenerator extends StreamableGenerator {
|
|
57671
|
1181 |
|
|
|
1182 |
/**
|
|
|
1183 |
* Returns an instance of {@link JumpableGenerator} that utilizes the
|
|
|
1184 |
* {@code name} algorithm.
|
|
|
1185 |
*
|
|
|
1186 |
* @param name Name of random number generator algorithm
|
|
|
1187 |
*
|
|
|
1188 |
* @return An instance of {@link JumpableGenerator}
|
|
|
1189 |
*/
|
|
|
1190 |
public static JumpableGenerator of(String name) {
|
|
|
1191 |
Objects.requireNonNull(name);
|
|
|
1192 |
return RandomGeneratorFactory.of(name, JumpableGenerator.class);
|
|
|
1193 |
}
|
|
|
1194 |
|
|
|
1195 |
/**
|
|
|
1196 |
* Returns an instance of {@link JumpableGenerator} that utilizes the
|
|
|
1197 |
* specified {@code algorithm}.
|
|
|
1198 |
*
|
|
|
1199 |
* @param algorithm Random number generator algorithm
|
|
|
1200 |
*
|
|
|
1201 |
* @return An instance of {@link JumpableGenerator}
|
|
|
1202 |
*/
|
|
|
1203 |
public static JumpableGenerator of(Algorithm algorithm) {
|
|
|
1204 |
Objects.requireNonNull(algorithm);
|
|
|
1205 |
return RandomGeneratorFactory.of(algorithm.toString(), JumpableGenerator.class);
|
|
|
1206 |
}
|
|
|
1207 |
|
|
|
1208 |
/**
|
|
|
1209 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1210 |
* of {@link JumpableGenerator} that utilizes the {@code name} algorithm.
|
|
|
1211 |
*
|
|
|
1212 |
* @param name Name of random number generator algorithm
|
|
|
1213 |
*
|
|
57684
|
1214 |
* @return {@link RandomGeneratorFactory} of {@link JumpableGenerator}
|
|
57671
|
1215 |
*/
|
|
|
1216 |
public static RandomGeneratorFactory<JumpableGenerator> factoryOf(String name) {
|
|
|
1217 |
Objects.requireNonNull(name);
|
|
|
1218 |
return RandomGeneratorFactory.factoryOf(name, JumpableGenerator.class);
|
|
|
1219 |
}
|
|
|
1220 |
|
|
|
1221 |
/**
|
|
|
1222 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1223 |
* of {@link JumpableGenerator} that utilizes the specified {@code algorithm}.
|
|
|
1224 |
*
|
|
|
1225 |
* @param algorithm Random number generator algorithm
|
|
|
1226 |
*
|
|
57684
|
1227 |
* @return {@link RandomGeneratorFactory} of {@link JumpableGenerator}
|
|
57671
|
1228 |
*/
|
|
|
1229 |
public static RandomGeneratorFactory<JumpableGenerator> factoryOf(Algorithm algorithm) {
|
|
|
1230 |
Objects.requireNonNull(algorithm);
|
|
|
1231 |
return RandomGeneratorFactory.factoryOf(algorithm.toString(), JumpableGenerator.class);
|
|
|
1232 |
}
|
|
|
1233 |
|
|
57547
|
1234 |
/**
|
|
|
1235 |
* Returns a new generator whose internal state is an exact copy of this generator (therefore
|
|
|
1236 |
* their future behavior should be identical if subjected to the same series of operations).
|
|
|
1237 |
*
|
|
|
1238 |
* @return a new object that is a copy of this generator
|
|
|
1239 |
*/
|
|
|
1240 |
JumpableGenerator copy();
|
|
|
1241 |
|
|
|
1242 |
/**
|
|
|
1243 |
* Alter the state of this pseudorandom number generator so as to jump forward a large, fixed
|
|
|
1244 |
* distance (typically 2<sup>64</sup> or more) within its state cycle.
|
|
|
1245 |
*/
|
|
|
1246 |
void jump();
|
|
|
1247 |
|
|
|
1248 |
/**
|
|
|
1249 |
* Returns the distance by which the {@code jump()} method will jump forward within the state
|
|
|
1250 |
* cycle of this generator object.
|
|
|
1251 |
*
|
|
|
1252 |
* @return the default jump distance (as a {@code double} value)
|
|
|
1253 |
*/
|
|
|
1254 |
double defaultJumpDistance();
|
|
|
1255 |
|
|
|
1256 |
/**
|
|
|
1257 |
* Returns an effectively unlimited stream of new pseudorandom number generators, each of which
|
|
|
1258 |
* implements the {@link RandomGenerator} interface.
|
|
|
1259 |
*
|
|
|
1260 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1261 |
*
|
|
|
1262 |
* @implNote It is permitted to implement this method in a manner equivalent to
|
|
|
1263 |
* {@code jumps(Long.MAX_VALUE)}.
|
|
|
1264 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
1265 |
* calls {@code copy()} and {@code jump()} on this generator, and the copies become the
|
|
|
1266 |
* generators produced by the stream.
|
|
|
1267 |
*/
|
|
|
1268 |
default Stream<RandomGenerator> jumps() {
|
|
|
1269 |
return Stream.generate(this::copyAndJump).sequential();
|
|
|
1270 |
}
|
|
|
1271 |
|
|
|
1272 |
/**
|
|
|
1273 |
* Returns a stream producing the given {@code streamSize} number of new pseudorandom number
|
|
|
1274 |
* generators, each of which implements the {@link RandomGenerator} interface.
|
|
|
1275 |
*
|
|
|
1276 |
* @param streamSize the number of generators to generate
|
|
|
1277 |
*
|
|
|
1278 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1279 |
*
|
|
|
1280 |
* @throws IllegalArgumentException if {@code streamSize} is less than zero
|
|
|
1281 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
1282 |
* calls {@code copy()} and {@code jump()} on this generator, and the copies become the
|
|
|
1283 |
* generators produced by the stream.
|
|
|
1284 |
*/
|
|
|
1285 |
default Stream<RandomGenerator> jumps(long streamSize) {
|
|
|
1286 |
return jumps().limit(streamSize);
|
|
|
1287 |
}
|
|
|
1288 |
|
|
|
1289 |
/**
|
|
|
1290 |
* Returns an effectively unlimited stream of new pseudorandom number generators, each of which
|
|
|
1291 |
* implements the {@link RandomGenerator} interface. Ideally the generators in the stream
|
|
|
1292 |
* will appear to be statistically independent.
|
|
|
1293 |
*
|
|
|
1294 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1295 |
*
|
|
|
1296 |
* @implNote The default implementation calls {@code jumps()}.
|
|
|
1297 |
*/
|
|
|
1298 |
default Stream<RandomGenerator> rngs() {
|
|
|
1299 |
return this.jumps();
|
|
|
1300 |
}
|
|
|
1301 |
|
|
|
1302 |
/**
|
|
|
1303 |
* Returns a stream producing the given {@code streamSize} number of new pseudorandom number
|
|
|
1304 |
* generators, each of which implements the {@link RandomGenerator} interface. Ideally
|
|
|
1305 |
* the generators in the stream will appear to be statistically independent.
|
|
|
1306 |
*
|
|
|
1307 |
* @param streamSize the number of generators to generate
|
|
|
1308 |
*
|
|
|
1309 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1310 |
*
|
|
|
1311 |
* @throws IllegalArgumentException if {@code streamSize} is less than zero
|
|
|
1312 |
* @implNote The default implementation calls {@code jumps(streamSize)}.
|
|
|
1313 |
*/
|
|
|
1314 |
default Stream<RandomGenerator> rngs(long streamSize) {
|
|
|
1315 |
return this.jumps(streamSize);
|
|
|
1316 |
}
|
|
|
1317 |
|
|
|
1318 |
/**
|
|
|
1319 |
* Copy this generator, jump this generator forward, then return the copy.
|
|
|
1320 |
*
|
|
|
1321 |
* @return a copy of this generator object before the jump occurred
|
|
|
1322 |
*/
|
|
|
1323 |
default RandomGenerator copyAndJump() {
|
|
|
1324 |
RandomGenerator result = copy();
|
|
|
1325 |
jump();
|
|
|
1326 |
return result;
|
|
|
1327 |
}
|
|
|
1328 |
|
|
|
1329 |
}
|
|
|
1330 |
|
|
|
1331 |
/**
|
|
57684
|
1332 |
* This interface is designed to provide a common protocol for objects that generate sequences
|
|
|
1333 |
* of pseudorandom numbers (or Boolean values) and furthermore can easily not only jump but
|
|
|
1334 |
* also
|
|
57547
|
1335 |
* <i>leap</i> to a very distant point in the state cycle.
|
|
|
1336 |
* <p>
|
|
57684
|
1337 |
* Typically one will construct a series of {@link LeapableGenerator} objects by iterative
|
|
|
1338 |
* leaping from a single original {@link LeapableGenerator} object, and then for each such
|
|
|
1339 |
* object produce a subseries of objects by iterative jumping. There is little conceptual
|
|
|
1340 |
* difference between leaping and jumping, but typically a leap will be a very long jump in the
|
|
|
1341 |
* state cycle (perhaps distance 2<sup>128</sup> or so).
|
|
57547
|
1342 |
* <p>
|
|
57684
|
1343 |
* Ideally, all {@link LeapableGenerator} objects produced by iterative leaping and jumping from
|
|
|
1344 |
* a single original {@link LeapableGenerator} object are statistically independent of one
|
|
|
1345 |
* another and individually uniform. In practice, one must settle for some approximation to
|
|
|
1346 |
* independence and uniformity. In particular, a specific implementation may assume that each
|
|
|
1347 |
* generator in a stream produced by the {@code leaps} method is used to produce (by jumping) a
|
|
|
1348 |
* number of objects no larger than 2<sup>64</sup>. Implementors are advised to use algorithms
|
|
|
1349 |
* whose period is at least 2<sup>191</sup>.
|
|
57547
|
1350 |
* <p>
|
|
|
1351 |
* Methods are provided to perform a single leap operation and also to produce a stream of
|
|
57684
|
1352 |
* generators produced from the original by iterative copying and leaping of internal state.
|
|
|
1353 |
* The generators produced must implement the {@link JumpableGenerator} interface but need not
|
|
|
1354 |
* also implement the {@link LeapableGenerator} interface. A typical strategy for a
|
|
|
1355 |
* multithreaded application is to create a single {@link LeapableGenerator} object, calls its
|
|
|
1356 |
* {@code leaps} method exactly once, and then parcel out generators from the resulting stream,
|
|
|
1357 |
* one to each thread. Then the {@code jumps} method of each such generator be called to
|
|
|
1358 |
* produce a substream of generator objects.
|
|
57547
|
1359 |
* <p>
|
|
57684
|
1360 |
* An implementation of the {@link LeapableGenerator} interface must provide concrete
|
|
|
1361 |
* definitions for the methods {@code nextInt()}, {@code nextLong}, {@code period()},
|
|
|
1362 |
* {@code copy()}, {@code jump()}, {@code defaultJumpDistance()}, {@code leap()},
|
|
|
1363 |
* and {@code defaultLeapDistance()}. Default implementations are provided for all other
|
|
|
1364 |
* methods.
|
|
57547
|
1365 |
* <p>
|
|
57684
|
1366 |
* Objects that implement {@link LeapableGenerator} are typically not cryptographically secure.
|
|
|
1367 |
* Consider instead using {@link java.security.SecureRandom} to get a cryptographically secure
|
|
|
1368 |
* pseudo-random number generator for use by security-sensitive applications.
|
|
57547
|
1369 |
*
|
|
|
1370 |
* @since 14
|
|
|
1371 |
*/
|
|
|
1372 |
public interface LeapableGenerator extends JumpableGenerator {
|
|
57671
|
1373 |
|
|
|
1374 |
/**
|
|
|
1375 |
* Returns an instance of {@link LeapableGenerator} that utilizes the
|
|
|
1376 |
* {@code name} algorithm.
|
|
|
1377 |
*
|
|
|
1378 |
* @param name Name of random number generator algorithm
|
|
|
1379 |
*
|
|
|
1380 |
* @return An instance of {@link LeapableGenerator}
|
|
|
1381 |
*/
|
|
|
1382 |
public static LeapableGenerator of(String name) {
|
|
|
1383 |
Objects.requireNonNull(name);
|
|
|
1384 |
return RandomGeneratorFactory.of(name, LeapableGenerator.class);
|
|
|
1385 |
}
|
|
|
1386 |
|
|
|
1387 |
/**
|
|
|
1388 |
* Returns an instance of {@link LeapableGenerator} that utilizes the
|
|
|
1389 |
* specified {@code algorithm}.
|
|
|
1390 |
*
|
|
|
1391 |
* @param algorithm Random number generator algorithm
|
|
|
1392 |
*
|
|
|
1393 |
* @return An instance of {@link LeapableGenerator}
|
|
|
1394 |
*/
|
|
|
1395 |
public static LeapableGenerator of(Algorithm algorithm) {
|
|
|
1396 |
Objects.requireNonNull(algorithm);
|
|
|
1397 |
return RandomGeneratorFactory.of(algorithm.toString(), LeapableGenerator.class);
|
|
|
1398 |
}
|
|
|
1399 |
|
|
|
1400 |
/**
|
|
|
1401 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1402 |
* of {@link LeapableGenerator} that utilizes the {@code name} algorithm.
|
|
|
1403 |
*
|
|
|
1404 |
* @param name Name of random number generator algorithm
|
|
|
1405 |
*
|
|
57684
|
1406 |
* @return {@link RandomGeneratorFactory} of {@link LeapableGenerator}
|
|
57671
|
1407 |
*/
|
|
|
1408 |
public static RandomGeneratorFactory<LeapableGenerator> factoryOf(String name) {
|
|
|
1409 |
Objects.requireNonNull(name);
|
|
|
1410 |
return RandomGeneratorFactory.factoryOf(name, LeapableGenerator.class);
|
|
|
1411 |
}
|
|
|
1412 |
|
|
|
1413 |
/**
|
|
|
1414 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1415 |
* of {@link LeapableGenerator} that utilizes the specified {@code algorithm}.
|
|
|
1416 |
*
|
|
|
1417 |
* @param algorithm Random number generator algorithm
|
|
|
1418 |
*
|
|
57684
|
1419 |
* @return {@link RandomGeneratorFactory} of {@link LeapableGenerator}
|
|
57671
|
1420 |
*/
|
|
|
1421 |
public static RandomGeneratorFactory<LeapableGenerator> factoryOf(Algorithm algorithm) {
|
|
|
1422 |
Objects.requireNonNull(algorithm);
|
|
|
1423 |
return RandomGeneratorFactory.factoryOf(algorithm.toString(), LeapableGenerator.class);
|
|
|
1424 |
}
|
|
|
1425 |
|
|
57547
|
1426 |
/**
|
|
|
1427 |
* Returns a new generator whose internal state is an exact copy of this generator (therefore
|
|
|
1428 |
* their future behavior should be identical if subjected to the same series of operations).
|
|
|
1429 |
*
|
|
|
1430 |
* @return a new object that is a copy of this generator
|
|
|
1431 |
*/
|
|
|
1432 |
LeapableGenerator copy();
|
|
|
1433 |
|
|
|
1434 |
/**
|
|
|
1435 |
* Alter the state of this pseudorandom number generator so as to leap forward a large, fixed
|
|
|
1436 |
* distance (typically 2<sup>96</sup> or more) within its state cycle.
|
|
|
1437 |
*/
|
|
|
1438 |
void leap();
|
|
|
1439 |
|
|
|
1440 |
/**
|
|
|
1441 |
* Returns the distance by which the {@code leap()} method will leap forward within the state
|
|
|
1442 |
* cycle of this generator object.
|
|
|
1443 |
*
|
|
|
1444 |
* @return the default leap distance (as a {@code double} value)
|
|
|
1445 |
*/
|
|
|
1446 |
double defaultLeapDistance();
|
|
|
1447 |
|
|
|
1448 |
/**
|
|
|
1449 |
* Returns an effectively unlimited stream of new pseudorandom number generators, each of which
|
|
|
1450 |
* implements the {@link JumpableGenerator} interface.
|
|
|
1451 |
*
|
|
|
1452 |
* @return a stream of objects that implement the {@link JumpableGenerator} interface
|
|
|
1453 |
*
|
|
|
1454 |
* @implNote It is permitted to implement this method in a manner equivalent to {@code
|
|
|
1455 |
* leaps(Long.MAX_VALUE)}.
|
|
|
1456 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
1457 |
* calls {@code copy()} and {@code leap()} on this generator, and the copies become the
|
|
|
1458 |
* generators produced by the stream.
|
|
|
1459 |
*/
|
|
|
1460 |
default Stream<JumpableGenerator> leaps() {
|
|
|
1461 |
return Stream.generate(this::copyAndLeap).sequential();
|
|
|
1462 |
}
|
|
|
1463 |
|
|
|
1464 |
/**
|
|
|
1465 |
* Returns a stream producing the given {@code streamSize} number of new pseudorandom number
|
|
|
1466 |
* generators, each of which implements the {@link JumpableGenerator} interface.
|
|
|
1467 |
*
|
|
|
1468 |
* @param streamSize the number of generators to generate
|
|
|
1469 |
*
|
|
|
1470 |
* @return a stream of objects that implement the {@link JumpableGenerator} interface
|
|
|
1471 |
*
|
|
|
1472 |
* @throws IllegalArgumentException if {@code streamSize} is less than zero
|
|
|
1473 |
* @implNote The default implementation produces a sequential stream that repeatedly
|
|
|
1474 |
* calls {@code copy()} and {@code leap()} on this generator, and the copies become the
|
|
|
1475 |
* generators produced by the stream.
|
|
|
1476 |
*/
|
|
|
1477 |
default Stream<JumpableGenerator> leaps(long streamSize) {
|
|
|
1478 |
return leaps().limit(streamSize);
|
|
|
1479 |
}
|
|
|
1480 |
|
|
|
1481 |
/**
|
|
|
1482 |
* Copy this generator, leap this generator forward, then return the copy.
|
|
|
1483 |
*
|
|
|
1484 |
* @return a copy of this generator object before the leap occurred
|
|
|
1485 |
*/
|
|
|
1486 |
default JumpableGenerator copyAndLeap() {
|
|
|
1487 |
JumpableGenerator result = copy();
|
|
|
1488 |
leap();
|
|
|
1489 |
return result;
|
|
|
1490 |
}
|
|
|
1491 |
|
|
|
1492 |
}
|
|
|
1493 |
|
|
|
1494 |
/**
|
|
57684
|
1495 |
* This interface is designed to provide a common protocol for objects that generate sequences
|
|
|
1496 |
* of pseudorandom numbers (or Boolean values) and furthermore can easily <i>jump</i> to an
|
|
|
1497 |
* arbitrarily specified distant point in the state cycle.
|
|
57547
|
1498 |
* <p>
|
|
57684
|
1499 |
* Ideally, all {@link ArbitrarilyJumpableGenerator} objects produced by iterative jumping from
|
|
|
1500 |
* a single original {@link ArbitrarilyJumpableGenerator} object are statistically independent
|
|
|
1501 |
* of one another and individually uniform, provided that they do not traverse overlapping
|
|
|
1502 |
* portions of the state cycle. In practice, one must settle for some approximation to
|
|
|
1503 |
* independence and uniformity. In particular, a specific implementation may assume that each
|
|
|
1504 |
* generator in a stream produced by the {@code jumps} method is used to produce a number of
|
|
|
1505 |
* values no larger than the jump distance specified. Implementors are advised to use
|
|
|
1506 |
* algorithms whose period is at least 2<sup>127</sup>.
|
|
57547
|
1507 |
* <p>
|
|
57684
|
1508 |
* For many applications, it suffices to jump forward by a power of two or some small multiple
|
|
|
1509 |
* of a power of two, but this power of two may not be representable as a {@code long} value.
|
|
|
1510 |
* To avoid the use of {@link java.math.BigInteger} values as jump distances, {@code double}
|
|
|
1511 |
* values are used instead.
|
|
57547
|
1512 |
* <p>
|
|
|
1513 |
* Methods are provided to perform a single jump operation and also to produce a stream of
|
|
|
1514 |
* generators produced from the original by iterative copying and jumping of internal state. A
|
|
57684
|
1515 |
* typical strategy for a multithreaded application is to create a single
|
|
|
1516 |
* {@link ArbitrarilyJumpableGenerator} object, call its {@code jumps} method exactly once, and
|
|
|
1517 |
* then parcel out generators from the resulting stream, one to each thread. However, each
|
|
|
1518 |
* generator produced also has type {@link ArbitrarilyJumpableGenerator}; with care, different
|
|
|
1519 |
* jump distances can be used to traverse the entire state cycle in various ways.
|
|
57547
|
1520 |
* <p>
|
|
|
1521 |
* An implementation of the {@link ArbitrarilyJumpableGenerator} interface must provide concrete
|
|
57684
|
1522 |
* definitions for the methods {@code nextInt()}, {@code nextLong}, {@code period()},
|
|
|
1523 |
* {@code copy()}, {@code jump(double)}, {@code defaultJumpDistance()}, and
|
|
|
1524 |
* {@code defaultLeapDistance()}. Default implementations are provided for all other methods.
|
|
|
1525 |
* Perhaps the most convenient way to implement this interface is to extend the abstract class
|
|
|
1526 |
* {@link ArbitrarilyJumpableGenerator}, which provides spliterator-based implementations of the
|
|
|
1527 |
* methods {@code ints}, {@code longs}, {@code doubles}, {@code rngs}, {@code jumps}, and
|
|
|
1528 |
* {@code leaps}.
|
|
57547
|
1529 |
* <p>
|
|
57684
|
1530 |
* Objects that implement {@link ArbitrarilyJumpableGenerator} are typically not
|
|
|
1531 |
* cryptographically secure. Consider instead using {@link java.security.SecureRandom} to get a
|
|
|
1532 |
* cryptographically secure pseudo-random number generator for use by security-sensitive
|
|
|
1533 |
* applications.
|
|
57547
|
1534 |
*
|
|
|
1535 |
* @since 14
|
|
|
1536 |
*/
|
|
|
1537 |
public interface ArbitrarilyJumpableGenerator extends LeapableGenerator {
|
|
57671
|
1538 |
|
|
|
1539 |
/**
|
|
|
1540 |
* Returns an instance of {@link ArbitrarilyJumpableGenerator} that utilizes the
|
|
|
1541 |
* {@code name} algorithm.
|
|
|
1542 |
*
|
|
|
1543 |
* @param name Name of random number generator algorithm
|
|
|
1544 |
*
|
|
|
1545 |
* @return An instance of {@link ArbitrarilyJumpableGenerator}
|
|
|
1546 |
*/
|
|
|
1547 |
public static ArbitrarilyJumpableGenerator of(String name) {
|
|
|
1548 |
Objects.requireNonNull(name);
|
|
|
1549 |
return RandomGeneratorFactory.of(name, ArbitrarilyJumpableGenerator.class);
|
|
|
1550 |
}
|
|
|
1551 |
|
|
|
1552 |
/**
|
|
|
1553 |
* Returns an instance of {@link ArbitrarilyJumpableGenerator} that utilizes the
|
|
|
1554 |
* specified {@code algorithm}.
|
|
|
1555 |
*
|
|
|
1556 |
* @param algorithm Random number generator algorithm
|
|
|
1557 |
*
|
|
|
1558 |
* @return An instance of {@link ArbitrarilyJumpableGenerator}
|
|
|
1559 |
*/
|
|
|
1560 |
public static ArbitrarilyJumpableGenerator of(Algorithm algorithm) {
|
|
|
1561 |
Objects.requireNonNull(algorithm);
|
|
|
1562 |
return RandomGeneratorFactory.of(algorithm.toString(), ArbitrarilyJumpableGenerator.class);
|
|
|
1563 |
}
|
|
|
1564 |
|
|
|
1565 |
/**
|
|
|
1566 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1567 |
* of {@link ArbitrarilyJumpableGenerator} that utilizes the {@code name} algorithm.
|
|
|
1568 |
*
|
|
|
1569 |
* @param name Name of random number generator algorithm
|
|
|
1570 |
*
|
|
57684
|
1571 |
* @return {@link RandomGeneratorFactory} of {@link ArbitrarilyJumpableGenerator}
|
|
57671
|
1572 |
*/
|
|
|
1573 |
public static RandomGeneratorFactory<ArbitrarilyJumpableGenerator> factoryOf(String name) {
|
|
|
1574 |
Objects.requireNonNull(name);
|
|
|
1575 |
return RandomGeneratorFactory.factoryOf(name, ArbitrarilyJumpableGenerator.class);
|
|
|
1576 |
}
|
|
|
1577 |
|
|
|
1578 |
/**
|
|
|
1579 |
* Returns a {@link RandomGeneratorFactory} that can produce instances
|
|
|
1580 |
* of {@link ArbitrarilyJumpableGenerator} that utilizes the specified {@code algorithm}.
|
|
|
1581 |
*
|
|
|
1582 |
* @param algorithm Random number generator algorithm
|
|
|
1583 |
*
|
|
57684
|
1584 |
* @return {@link RandomGeneratorFactory} of {@link ArbitrarilyJumpableGenerator}
|
|
57671
|
1585 |
*/
|
|
|
1586 |
public static RandomGeneratorFactory<ArbitrarilyJumpableGenerator> factoryOf(Algorithm algorithm) {
|
|
|
1587 |
Objects.requireNonNull(algorithm);
|
|
|
1588 |
return RandomGeneratorFactory.factoryOf(algorithm.toString(), ArbitrarilyJumpableGenerator.class);
|
|
|
1589 |
}
|
|
|
1590 |
|
|
57547
|
1591 |
/**
|
|
|
1592 |
* Returns a new generator whose internal state is an exact copy of this generator (therefore
|
|
|
1593 |
* their future behavior should be identical if subjected to the same series of operations).
|
|
|
1594 |
*
|
|
|
1595 |
* @return a new object that is a copy of this generator
|
|
|
1596 |
*/
|
|
|
1597 |
ArbitrarilyJumpableGenerator copy();
|
|
|
1598 |
|
|
|
1599 |
/**
|
|
|
1600 |
* Alter the state of this pseudorandom number generator so as to jump forward a distance equal
|
|
|
1601 |
* to 2<sup>{@code logDistance}</sup> within its state cycle.
|
|
|
1602 |
*
|
|
|
1603 |
* @param logDistance the base-2 logarithm of the distance to jump forward within the state
|
|
|
1604 |
* cycle
|
|
|
1605 |
*
|
|
|
1606 |
* @throws IllegalArgumentException if {@code logDistance} is NaN or negative, or if
|
|
|
1607 |
* 2<sup>{@code logDistance}</sup> is greater than the period
|
|
|
1608 |
* of this generator
|
|
|
1609 |
*/
|
|
|
1610 |
void jumpPowerOfTwo(int logDistance);
|
|
|
1611 |
|
|
|
1612 |
/**
|
|
|
1613 |
* Alter the state of this pseudorandom number generator so as to jump forward a specified
|
|
|
1614 |
* distance within its state cycle.
|
|
|
1615 |
*
|
|
|
1616 |
* @param distance the distance to jump forward within the state cycle
|
|
|
1617 |
*
|
|
|
1618 |
* @throws IllegalArgumentException if {@code distance} is Nan, negative, or greater than the
|
|
|
1619 |
* period of this generator
|
|
|
1620 |
*/
|
|
|
1621 |
void jump(double distance);
|
|
|
1622 |
|
|
|
1623 |
/**
|
|
|
1624 |
* Alter the state of this pseudorandom number generator so as to jump forward a large, fixed
|
|
|
1625 |
* distance (typically 2<sup>64</sup> or more) within its state cycle. The distance used is
|
|
|
1626 |
* that returned by method {@code defaultJumpDistance()}.
|
|
|
1627 |
*/
|
|
|
1628 |
default void jump() { jump(defaultJumpDistance()); }
|
|
|
1629 |
|
|
|
1630 |
/**
|
|
57684
|
1631 |
* Returns an effectively unlimited stream of new pseudorandom number generators, each of
|
|
|
1632 |
* which implements the {@link ArbitrarilyJumpableGenerator} interface, produced by jumping
|
|
|
1633 |
* copies of this generator by different integer multiples of the specified jump distance.
|
|
57547
|
1634 |
*
|
|
|
1635 |
* @param distance a distance to jump forward within the state cycle
|
|
|
1636 |
*
|
|
|
1637 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1638 |
*
|
|
|
1639 |
* @implNote This method is implemented to be equivalent to {@code jumps(Long.MAX_VALUE)}.
|
|
|
1640 |
*/
|
|
|
1641 |
default Stream<ArbitrarilyJumpableGenerator> jumps(double distance) {
|
|
|
1642 |
return Stream.generate(() -> copyAndJump(distance)).sequential();
|
|
|
1643 |
}
|
|
|
1644 |
|
|
|
1645 |
/**
|
|
|
1646 |
* Returns a stream producing the given {@code streamSize} number of new pseudorandom number
|
|
57684
|
1647 |
* generators, each of which implements the {@link ArbitrarilyJumpableGenerator} interface,
|
|
|
1648 |
* produced by jumping copies of this generator by different integer multiples of the
|
|
|
1649 |
* specified jump distance.
|
|
57547
|
1650 |
*
|
|
|
1651 |
* @param streamSize the number of generators to generate
|
|
|
1652 |
* @param distance a distance to jump forward within the state cycle
|
|
|
1653 |
*
|
|
|
1654 |
* @return a stream of objects that implement the {@link RandomGenerator} interface
|
|
|
1655 |
*
|
|
|
1656 |
* @throws IllegalArgumentException if {@code streamSize} is less than zero
|
|
|
1657 |
*/
|
|
|
1658 |
default Stream<ArbitrarilyJumpableGenerator> jumps(long streamSize, double distance) {
|
|
|
1659 |
return jumps(distance).limit(streamSize);
|
|
|
1660 |
}
|
|
|
1661 |
|
|
|
1662 |
/**
|
|
|
1663 |
* Alter the state of this pseudorandom number generator so as to jump forward a very large,
|
|
57684
|
1664 |
* fixed distance (typically 2<sup>128</sup> or more) within its state cycle. The distance
|
|
|
1665 |
* used is that returned by method {@code defaultJLeapDistance()}.
|
|
57547
|
1666 |
*/
|
|
|
1667 |
default void leap() { jump(defaultLeapDistance()); }
|
|
|
1668 |
|
|
|
1669 |
/**
|
|
|
1670 |
* Copy this generator, jump this generator forward, then return the copy.
|
|
|
1671 |
*
|
|
|
1672 |
* @param distance a distance to jump forward within the state cycle
|
|
|
1673 |
*
|
|
|
1674 |
* @return a copy of this generator object before the jump occurred
|
|
|
1675 |
*/
|
|
|
1676 |
default ArbitrarilyJumpableGenerator copyAndJump(double distance) {
|
|
|
1677 |
ArbitrarilyJumpableGenerator result = copy();
|
|
|
1678 |
jump(distance);
|
|
|
1679 |
return result;
|
|
|
1680 |
}
|
|
|
1681 |
|
|
|
1682 |
}
|
|
|
1683 |
}
|