![]() |
Synthia
Generic and flexible data structure generator
|
An instance of this class is used to generate a stream of pseudorandom numbers.
The class uses a 48-bit seed, which is modified using a linear congruential formula. (See Donald Knuth, The Art of Computer Programming, Volume 2, Section 3.2.1.)
If two instances of
are created with the same seed, and the same sequence of method calls is made for each, they will generate and return identical sequences of numbers. In order to guarantee this property, particular algorithms are specified for the class
. Java implementations must use all the algorithms shown here for the class
, for the sake of absolute portability of Java code. However, subclasses of class
are permitted to use other algorithms, so long as they adhere to the general contracts for all the methods.
The algorithms implemented by class
use a
utility method that on each invocation can supply up to 32 pseudorandomly generated bits.
Many applications will find the method Math#random simpler to use.
Instances of
are threadsafe. However, the concurrent use of the same
instance across threads may encounter contention and consequent poor performance. Consider instead using java.util.concurrent.ThreadLocalRandom in multithreaded designs.
Instances of
are not cryptographically secure. Consider instead using java.security.SecureRandom to get a cryptographically secure pseudo-random number generator for use by security-sensitive applications.
Definition at line 75 of file Random.java.
Classes | |
| class | RandomDoublesSpliterator |
| Spliterator for double streams. | |
| class | RandomIntsSpliterator |
| Spliterator for int streams. | |
| class | RandomLongsSpliterator |
| Spliterator for long streams. | |
Public Member Functions | |
| Random () | |
| Creates a new random number generator. More... | |
| Random | Duplicate () |
| Creates a new instance of the class with the exact same internal states that the original one. More... | |
| Random (long seed) | |
| Creates a new random number generator using a single. More... | |
| synchronized void | setSeed (long seed) |
| Sets the seed of this random number generator using a single. More... | |
| void | nextBytes (byte[] bytes) |
| Generates random bytes and places them into a user-supplied byte array. More... | |
| int | nextInt () |
| Returns the next pseudorandom, uniformly distributed. More... | |
| int | nextInt (int bound) |
| Returns a pseudorandom, uniformly distributed. More... | |
| long | nextLong () |
| Returns the next pseudorandom, uniformly distributed. More... | |
| boolean | nextBoolean () |
| Returns the next pseudorandom, uniformly distributed. More... | |
| float | nextFloat () |
| Returns the next pseudorandom, uniformly distributed. More... | |
| double | nextDouble () |
| Returns the next pseudorandom, uniformly distributed. More... | |
| synchronized double | nextGaussian () |
| Returns the next pseudorandom, Gaussian ("normally") distributed. More... | |
| IntStream | ints (long streamSize) |
| Returns a stream producing the given. More... | |
| IntStream | ints () |
| Returns an effectively unlimited stream of pseudorandom. More... | |
| IntStream | ints (long streamSize, int randomNumberOrigin, int randomNumberBound) |
| Returns a stream producing the given. More... | |
| IntStream | ints (int randomNumberOrigin, int randomNumberBound) |
| Returns an effectively unlimited stream of pseudorandom. More... | |
| LongStream | longs (long streamSize) |
| Returns a stream producing the given. More... | |
| LongStream | longs () |
| Returns an effectively unlimited stream of pseudorandom. More... | |
| LongStream | longs (long streamSize, long randomNumberOrigin, long randomNumberBound) |
| Returns a stream producing the given. More... | |
| LongStream | longs (long randomNumberOrigin, long randomNumberBound) |
| Returns an effectively unlimited stream of pseudorandom. More... | |
| DoubleStream | doubles (long streamSize) |
| Returns a stream producing the given. More... | |
| DoubleStream | doubles () |
| Returns an effectively unlimited stream of pseudorandom. More... | |
| DoubleStream | doubles (long streamSize, double randomNumberOrigin, double randomNumberBound) |
| Returns a stream producing the given. More... | |
| DoubleStream | doubles (double randomNumberOrigin, double randomNumberBound) |
| Returns an effectively unlimited stream of pseudorandom. More... | |
Protected Member Functions | |
| int | next (int bits) |
| Generates the next pseudorandom number. More... | |
| ca.uqac.lif.synthia.random.Random.Random | ( | ) |
Creates a new random number generator.
This constructor sets the seed of the random number generator to a value very likely to be distinct from any other invocation of this constructor.
Definition at line 102 of file Random.java.
| ca.uqac.lif.synthia.random.Random.Random | ( | long | seed | ) |
Creates a new random number generator using a single.
seed. The seed is the initial value of the internal state of the pseudorandom number generator which is maintained by method next.
The invocation
is equivalent to:
| seed | the initial seed |
Definition at line 155 of file Random.java.
| DoubleStream ca.uqac.lif.synthia.random.Random.doubles | ( | ) |
Returns an effectively unlimited stream of pseudorandom.
values, each between zero (inclusive) and one (exclusive).
A pseudorandom
value is generated as if it's the result of calling the method nextDouble()}.
@implNote This method is implemented to be equivalent to
.
Definition at line 928 of file Random.java.
| DoubleStream ca.uqac.lif.synthia.random.Random.doubles | ( | double | randomNumberOrigin, |
| double | randomNumberBound | ||
| ) |
Returns an effectively unlimited stream of pseudorandom.
values, each conforming to the given origin (inclusive) and bound (exclusive).
A pseudorandom
value is generated as if it's the result of calling the following method with the origin and bound:
double r = nextDouble();r = r * (bound - origin) + origin;if (r >= bound) // correct for roundingr = Math.nextDown(bound);return r;}
@implNote This method is implemented to be equivalent to
.
| randomNumberOrigin | the origin (inclusive) of each random value |
| randomNumberBound | the bound (exclusive) of each random value |
| IllegalArgumentException | if randomNumberOrigin
randomNumberBound
|
Definition at line 1001 of file Random.java.
| DoubleStream ca.uqac.lif.synthia.random.Random.doubles | ( | long | streamSize | ) |
Returns a stream producing the given.
number of pseudorandom
values, each between zero (inclusive) and one (exclusive).
A pseudorandom
value is generated as if it's the result of calling the method nextDouble()}.
| streamSize | the number of values to generate |
| IllegalArgumentException | if streamSize
|
Definition at line 905 of file Random.java.
| DoubleStream ca.uqac.lif.synthia.random.Random.doubles | ( | long | streamSize, |
| double | randomNumberOrigin, | ||
| double | randomNumberBound | ||
| ) |
Returns a stream producing the given.
number of pseudorandom
values, each conforming to the given origin (inclusive) and bound (exclusive).
A pseudorandom
value is generated as if it's the result of calling the following method with the origin and bound:
double r = nextDouble();r = r * (bound - origin) + origin;if (r >= bound) // correct for roundingr = Math.nextDown(bound);return r;}
| streamSize | the number of values to generate |
| randomNumberOrigin | the origin (inclusive) of each random value |
| randomNumberBound | the bound (exclusive) of each random value |
| IllegalArgumentException | if streamSize
|
| IllegalArgumentException | if randomNumberOrigin
randomNumberBound
|
Definition at line 962 of file Random.java.
| Random ca.uqac.lif.synthia.random.Random.Duplicate | ( | ) |
Creates a new instance of the class with the exact same internal states that the original one.
Definition at line 123 of file Random.java.
| IntStream ca.uqac.lif.synthia.random.Random.ints | ( | ) |
Returns an effectively unlimited stream of pseudorandom.
values.
A pseudorandom
value is generated as if it's the result of calling the method nextInt().
@implNote This method is implemented to be equivalent to
.
Definition at line 660 of file Random.java.
| IntStream ca.uqac.lif.synthia.random.Random.ints | ( | int | randomNumberOrigin, |
| int | randomNumberBound | ||
| ) |
Returns an effectively unlimited stream of pseudorandom.
values, each conforming to the given origin (inclusive) and bound (exclusive).
A pseudorandom
value is generated as if it's the result of calling the following method with the origin and bound:
@implNote This method is implemented to be equivalent to
.
| randomNumberOrigin | the origin (inclusive) of each random value |
| randomNumberBound | the bound (exclusive) of each random value |
| IllegalArgumentException | if randomNumberOrigin
randomNumberBound
|
Definition at line 744 of file Random.java.
| IntStream ca.uqac.lif.synthia.random.Random.ints | ( | long | streamSize | ) |
Returns a stream producing the given.
number of pseudorandom
values.
A pseudorandom
value is generated as if it's the result of calling the method nextInt().
| streamSize | the number of values to generate |
| IllegalArgumentException | if streamSize
|
Definition at line 638 of file Random.java.
| IntStream ca.uqac.lif.synthia.random.Random.ints | ( | long | streamSize, |
| int | randomNumberOrigin, | ||
| int | randomNumberBound | ||
| ) |
Returns a stream producing the given.
number of pseudorandom
values, each conforming to the given origin (inclusive) and bound (exclusive).
A pseudorandom
value is generated as if it's the result of calling the following method with the origin and bound:
| streamSize | the number of values to generate |
| randomNumberOrigin | the origin (inclusive) of each random value |
| randomNumberBound | the bound (exclusive) of each random value |
| IllegalArgumentException | if streamSize
randomNumberOrigin
randomNumberBound
|
Definition at line 699 of file Random.java.
| LongStream ca.uqac.lif.synthia.random.Random.longs | ( | ) |
Returns an effectively unlimited stream of pseudorandom.
values.
A pseudorandom
value is generated as if it's the result of calling the method nextLong().
@implNote This method is implemented to be equivalent to
.
Definition at line 788 of file Random.java.
| LongStream ca.uqac.lif.synthia.random.Random.longs | ( | long | randomNumberOrigin, |
| long | randomNumberBound | ||
| ) |
Returns an effectively unlimited stream of pseudorandom.
values, each conforming to the given origin (inclusive) and bound (exclusive).
A pseudorandom
value is generated as if it's the result of calling the following method with the origin and bound:
long r = nextLong();long n = bound - origin, m = n - 1;if ((n & m) == 0L) // power of twor = (r & m) + origin;else if (n > 0L) { // reject over-represented candidatesfor (long u = r >>> 1; // ensure nonnegativeu + m - (r = u % n) < 0L; // rejection checku = nextLong() >>> 1) // retry;r += origin;}else { // range not representable as longwhile (r < origin || r >= bound)r = nextLong();}return r;}
@implNote This method is implemented to be equivalent to
.
| randomNumberOrigin | the origin (inclusive) of each random value |
| randomNumberBound | the bound (exclusive) of each random value |
| IllegalArgumentException | if randomNumberOrigin
randomNumberBound
|
Definition at line 882 of file Random.java.
| LongStream ca.uqac.lif.synthia.random.Random.longs | ( | long | streamSize | ) |
Returns a stream producing the given.
number of pseudorandom
values.
A pseudorandom
value is generated as if it's the result of calling the method nextLong().
| streamSize | the number of values to generate |
| IllegalArgumentException | if streamSize
|
Definition at line 766 of file Random.java.
| LongStream ca.uqac.lif.synthia.random.Random.longs | ( | long | streamSize, |
| long | randomNumberOrigin, | ||
| long | randomNumberBound | ||
| ) |
Returns a stream producing the given.
number of pseudorandom
, each conforming to the given origin (inclusive) and bound (exclusive).
A pseudorandom
value is generated as if it's the result of calling the following method with the origin and bound:
long r = nextLong();long n = bound - origin, m = n - 1;if ((n & m) == 0L) // power of twor = (r & m) + origin;else if (n > 0L) { // reject over-represented candidatesfor (long u = r >>> 1; // ensure nonnegativeu + m - (r = u % n) < 0L; // rejection checku = nextLong() >>> 1) // retry;r += origin;}else { // range not representable as longwhile (r < origin || r >= bound)r = nextLong();}return r;}
| streamSize | the number of values to generate |
| randomNumberOrigin | the origin (inclusive) of each random value |
| randomNumberBound | the bound (exclusive) of each random value |
| IllegalArgumentException | if streamSize
randomNumberOrigin
randomNumberBound
|
Definition at line 832 of file Random.java.
|
protected |
Generates the next pseudorandom number.
Subclasses should override this, as this is used by all other methods.
The general contract of
is that it returns an
value and if the argument
is between
and
(inclusive), then that many low-order bits of the returned value will be (approximately) independently chosen bit values, each of which is (approximately) equally likely to be
or
. The method
is implemented by class
by atomically updating the seed to
(seed * 0x5DEECE66DL + 0xBL) & ((1L << 48) - 1)
and returning
.(int)(seed >>> (48 - bits))
This is a linear congruential pseudorandom number generator, as defined by D. H. Lehmer and described by Donald E. Knuth in The Art of Computer Programming, Volume 3: Seminumerical Algorithms, section 3.2.1.
| bits | random bits |
Definition at line 218 of file Random.java.
| boolean ca.uqac.lif.synthia.random.Random.nextBoolean | ( | ) |
Returns the next pseudorandom, uniformly distributed.
value from this random number generator's sequence. The general contract of
is that one
value is pseudorandomly generated and returned. The values
and
are produced with (approximately) equal probability.
The method
is implemented by class
as if by:
Definition at line 467 of file Random.java.
| void ca.uqac.lif.synthia.random.Random.nextBytes | ( | byte[] | bytes | ) |
Generates random bytes and places them into a user-supplied byte array.
The number of random bytes produced is equal to the length of the byte array.
The method
is implemented by class
as if by:
| bytes | the byte array to fill with random bytes |
| NullPointerException | if the byte array is null |
Definition at line 247 of file Random.java.
| double ca.uqac.lif.synthia.random.Random.nextDouble | ( | ) |
Returns the next pseudorandom, uniformly distributed.
value between
and
from this random number generator's sequence.
The general contract of
is that one
value, chosen (approximately) uniformly from the range
(inclusive) to
(exclusive), is pseudorandomly generated and returned.
The method
is implemented by class
as if by:
The hedge "approximately" is used in the foregoing description only because the
method is only approximately an unbiased source of independently chosen bits. If it were a perfect source of randomly chosen bits, then the algorithm shown would choose
values from the stated range with perfect uniformity.
[In early versions of Java, the result was incorrectly calculated as:
This might seem to be equivalent, if not better, but in fact it introduced a large nonuniformity because of the bias in the rounding of floating-point numbers: it was three times as likely that the low-order bit of the significand would be 0 than that it would be 1! This nonuniformity probably doesn't matter much in practice, but we strive for perfection.]
Definition at line 551 of file Random.java.
| float ca.uqac.lif.synthia.random.Random.nextFloat | ( | ) |
Returns the next pseudorandom, uniformly distributed.
value between
and
from this random number generator's sequence.
The general contract of
is that one
value, chosen (approximately) uniformly from the range
(inclusive) to
(exclusive), is pseudorandomly generated and returned. All 224 possible
values of the form m x 2-24, where m is a positive integer less than 224, are produced with (approximately) equal probability.
The method
is implemented by class
as if by:
The hedge "approximately" is used in the foregoing description only because the next method is only approximately an unbiased source of independently chosen bits. If it were a perfect source of randomly chosen bits, then the algorithm shown would choose
values from the stated range with perfect uniformity.
[In early versions of Java, the result was incorrectly calculated as:
return next(30) / ((float)(1 << 30));
This might seem to be equivalent, if not better, but in fact it introduced a slight nonuniformity because of the bias in the rounding of floating-point numbers: it was slightly more likely that the low-order bit of the significand would be 0 than that it would be 1.]
Definition at line 508 of file Random.java.
| synchronized double ca.uqac.lif.synthia.random.Random.nextGaussian | ( | ) |
Returns the next pseudorandom, Gaussian ("normally") distributed.
value with mean
and standard deviation
from this random number generator's sequence.
The general contract of
is that one
value, chosen from (approximately) the usual normal distribution with mean
and standard deviation
, is pseudorandomly generated and returned.
The method
is implemented by class
as if by a threadsafe version of the following:
private double nextNextGaussian;private boolean haveNextNextGaussian = false;if (haveNextNextGaussian) {haveNextNextGaussian = false;return nextNextGaussian;} else {double v1, v2, s;do {v1 = 2 * nextDouble() - 1; // between -1.0 and 1.0v2 = 2 * nextDouble() - 1; // between -1.0 and 1.0s = v1 * v1 + v2 * v2;} while (s >= 1 || s == 0);double multiplier = StrictMath.sqrt(-2 * StrictMath.log(s)/s);nextNextGaussian = v2 * multiplier;haveNextNextGaussian = true;return v1 * multiplier;}}
This uses the polar method of G. E. P. Box, M. E. Muller, and G. Marsaglia, as described by Donald E. Knuth in The Art of Computer Programming, Volume 3: Seminumerical Algorithms, section 3.4.1, subsection C, algorithm P. Note that it generates two independent values at the cost of only one call to
and one call to
.
Definition at line 603 of file Random.java.
| int ca.uqac.lif.synthia.random.Random.nextInt | ( | ) |
Returns the next pseudorandom, uniformly distributed.
value from this random number generator's sequence. The general contract of
is that one
value is pseudorandomly generated and returned. All 232 possible
values are produced with (approximately) equal probability.
The method
is implemented by class
as if by:
Definition at line 348 of file Random.java.
| int ca.uqac.lif.synthia.random.Random.nextInt | ( | int | bound | ) |
Returns a pseudorandom, uniformly distributed.
value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence. The general contract of
is that one
value in the specified range is pseudorandomly generated and returned. All
possible
values are produced with (approximately) equal probability. The method
is implemented by class
as if by:
if (bound <= 0)throw new IllegalArgumentException("bound must be positive");if ((bound & -bound) == bound) // i.e., bound is a power of 2int bits, val;do {bits = next(31);val = bits % bound;} while (bits - val + (bound-1) < 0);return val;}
The hedge "approximately" is used in the foregoing description only because the next method is only approximately an unbiased source of independently chosen bits. If it were a perfect source of randomly chosen bits, then the algorithm shown would choose
values from the stated range with perfect uniformity.
The algorithm is slightly tricky. It rejects values that would result in an uneven distribution (due to the fact that 2^31 is not divisible by n). The probability of a value being rejected depends on n. The worst case is n=2^30+1, for which the probability of a reject is 1/2, and the expected number of iterations before the loop terminates is 2.
The algorithm treats the case where n is a power of two specially: it returns the correct number of high-order bits from the underlying pseudo-random number generator. In the absence of special treatment, the correct number of low-order bits would be returned. Linear congruential pseudo-random number generators such as the one implemented by this class are known to have short periods in the sequence of values of their low-order bits. Thus, this special case greatly increases the length of the sequence of values returned by successive calls to this method if n is a small power of two.
| bound | the upper bound (exclusive). Must be positive. |
| IllegalArgumentException | if bound is not positive |
Definition at line 406 of file Random.java.
| long ca.uqac.lif.synthia.random.Random.nextLong | ( | ) |
Returns the next pseudorandom, uniformly distributed.
value from this random number generator's sequence. The general contract of
is that one
value is pseudorandomly generated and returned.
The method
is implemented by class
as if by:
Because class
uses a seed with only 48 bits, this algorithm will not return all possible
values.
Definition at line 442 of file Random.java.
| synchronized void ca.uqac.lif.synthia.random.Random.setSeed | ( | long | seed | ) |
Sets the seed of this random number generator using a single.
seed. The general contract of
is that it alters the state of this random number generator object so as to be in exactly the same state as if it had just been created with the argument
as a seed. The method
is implemented by class
by atomically updating the seed to
(seed ^ 0x5DEECE66DL) & ((1L << 48) - 1)
and clearing the
flag used by {}. The implementation of
by class
happens to use only 48 bits of the given seed. In general, however, an overriding method may use all 64 bits of the
argument as a seed value.
| seed | the initial seed |
Definition at line 188 of file Random.java.