Class ThreadLocalRandom
- java.lang.Object
-
- java.util.Random
-
- java.util.concurrent.ThreadLocalRandom
-
- All Implemented Interfaces:
- Serializable
public class ThreadLocalRandom extends Random
A random number generator isolated to the current thread. Like the globalRandom
generator used by theMath
class, aThreadLocalRandom
is initialized with an internally generated seed that may not otherwise be modified. When applicable, use ofThreadLocalRandom
rather than sharedRandom
objects in concurrent programs will typically encounter much less overhead and contention. Use ofThreadLocalRandom
is particularly appropriate when multiple tasks (for example, each aForkJoinTask
) use random numbers in parallel in thread pools.Usages of this class should typically be of the form:
ThreadLocalRandom.current().nextX(...)
(whereX
isInt
,Long
, etc). When all usages are of this form, it is never possible to accidently share aThreadLocalRandom
across multiple threads.This class also provides additional commonly used bounded random generation methods.
Instances of
ThreadLocalRandom
are not cryptographically secure. Consider instead usingSecureRandom
in security-sensitive applications. Additionally, default-constructed instances do not use a cryptographically random seed unless the system propertyjava.util.secureRandomSeed
is set totrue
.- Since:
- 1.7
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static ThreadLocalRandom
current()
Returns the current thread'sThreadLocalRandom
.DoubleStream
doubles()
Returns an effectively unlimited stream of pseudorandomdouble
values, each between zero (inclusive) and one (exclusive).DoubleStream
doubles(double randomNumberOrigin, double randomNumberBound)
Returns an effectively unlimited stream of pseudorandomdouble
values, each conforming to the given origin (inclusive) and bound (exclusive).DoubleStream
doubles(long streamSize)
Returns a stream producing the givenstreamSize
number of pseudorandomdouble
values, each between zero (inclusive) and one (exclusive).DoubleStream
doubles(long streamSize, double randomNumberOrigin, double randomNumberBound)
Returns a stream producing the givenstreamSize
number of pseudorandomdouble
values, each conforming to the given origin (inclusive) and bound (exclusive).IntStream
ints()
Returns an effectively unlimited stream of pseudorandomint
values.IntStream
ints(int randomNumberOrigin, int randomNumberBound)
Returns an effectively unlimited stream of pseudorandomint
values, each conforming to the given origin (inclusive) and bound (exclusive).IntStream
ints(long streamSize)
Returns a stream producing the givenstreamSize
number of pseudorandomint
values.IntStream
ints(long streamSize, int randomNumberOrigin, int randomNumberBound)
Returns a stream producing the givenstreamSize
number of pseudorandomint
values, each conforming to the given origin (inclusive) and bound (exclusive).LongStream
longs()
Returns an effectively unlimited stream of pseudorandomlong
values.LongStream
longs(long streamSize)
Returns a stream producing the givenstreamSize
number of pseudorandomlong
values.LongStream
longs(long randomNumberOrigin, long randomNumberBound)
Returns an effectively unlimited stream of pseudorandomlong
values, each conforming to the given origin (inclusive) and bound (exclusive).LongStream
longs(long streamSize, long randomNumberOrigin, long randomNumberBound)
Returns a stream producing the givenstreamSize
number of pseudorandomlong
, each conforming to the given origin (inclusive) and bound (exclusive).protected int
next(int bits)
Generates the next pseudorandom number.boolean
nextBoolean()
Returns a pseudorandomboolean
value.double
nextDouble()
Returns a pseudorandomdouble
value between zero (inclusive) and one (exclusive).double
nextDouble(double bound)
Returns a pseudorandomdouble
value between 0.0 (inclusive) and the specified bound (exclusive).double
nextDouble(double origin, double bound)
Returns a pseudorandomdouble
value between the specified origin (inclusive) and bound (exclusive).float
nextFloat()
Returns a pseudorandomfloat
value between zero (inclusive) and one (exclusive).double
nextGaussian()
Returns the next pseudorandom, Gaussian ("normally") distributeddouble
value with mean0.0
and standard deviation1.0
from this random number generator's sequence.int
nextInt()
Returns a pseudorandomint
value.int
nextInt(int bound)
Returns a pseudorandomint
value between zero (inclusive) and the specified bound (exclusive).int
nextInt(int origin, int bound)
Returns a pseudorandomint
value between the specified origin (inclusive) and the specified bound (exclusive).long
nextLong()
Returns a pseudorandomlong
value.long
nextLong(long bound)
Returns a pseudorandomlong
value between zero (inclusive) and the specified bound (exclusive).long
nextLong(long origin, long bound)
Returns a pseudorandomlong
value between the specified origin (inclusive) and the specified bound (exclusive).void
setSeed(long seed)
ThrowsUnsupportedOperationException
.
-
-
-
Method Detail
current
public static ThreadLocalRandom current()
Returns the current thread'sThreadLocalRandom
.- Returns:
-
the current thread's
ThreadLocalRandom
setSeed
public void setSeed(long seed)
ThrowsUnsupportedOperationException
. Setting seeds in this generator is not supported.- Overrides:
-
setSeed
in classRandom
- Parameters:
-
seed
- the initial seed - Throws:
-
UnsupportedOperationException
- always
next
protected int next(int bits)
Description copied from class:Random
Generates the next pseudorandom number. Subclasses should override this, as this is used by all other methods.The general contract of
next
is that it returns anint
value and if the argumentbits
is between1
and32
(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 be0
or1
. The methodnext
is implemented by classRandom
by atomically updating the seed to
and returning(seed * 0x5DEECE66DL + 0xBL) & ((1L << 48) - 1)
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.(int)(seed >>> (48 - bits))
.
nextInt
public int nextInt()
Returns a pseudorandomint
value.
nextInt
public int nextInt(int bound)
Returns a pseudorandomint
value between zero (inclusive) and the specified bound (exclusive).- Overrides:
-
nextInt
in classRandom
- Parameters:
-
bound
- the upper bound (exclusive). Must be positive. - Returns:
-
a pseudorandom
int
value between zero (inclusive) and the bound (exclusive) - Throws:
-
IllegalArgumentException
- ifbound
is not positive
nextInt
public int nextInt(int origin, int bound)
Returns a pseudorandomint
value between the specified origin (inclusive) and the specified bound (exclusive).- Parameters:
-
origin
- the least value returned -
bound
- the upper bound (exclusive) - Returns:
-
a pseudorandom
int
value between the origin (inclusive) and the bound (exclusive) - Throws:
-
IllegalArgumentException
- iforigin
is greater than or equal tobound
nextLong
public long nextLong()
Returns a pseudorandomlong
value.
nextLong
public long nextLong(long bound)
Returns a pseudorandomlong
value between zero (inclusive) and the specified bound (exclusive).- Parameters:
-
bound
- the upper bound (exclusive). Must be positive. - Returns:
-
a pseudorandom
long
value between zero (inclusive) and the bound (exclusive) - Throws:
-
IllegalArgumentException
- ifbound
is not positive
nextLong
public long nextLong(long origin, long bound)
Returns a pseudorandomlong
value between the specified origin (inclusive) and the specified bound (exclusive).- Parameters:
-
origin
- the least value returned -
bound
- the upper bound (exclusive) - Returns:
-
a pseudorandom
long
value between the origin (inclusive) and the bound (exclusive) - Throws:
-
IllegalArgumentException
- iforigin
is greater than or equal tobound
nextDouble
public double nextDouble()
Returns a pseudorandomdouble
value between zero (inclusive) and one (exclusive).- Overrides:
-
nextDouble
in classRandom
- Returns:
-
a pseudorandom
double
value between zero (inclusive) and one (exclusive) - See Also:
-
Math.random()
nextDouble
public double nextDouble(double bound)
Returns a pseudorandomdouble
value between 0.0 (inclusive) and the specified bound (exclusive).- Parameters:
-
bound
- the upper bound (exclusive). Must be positive. - Returns:
-
a pseudorandom
double
value between zero (inclusive) and the bound (exclusive) - Throws:
-
IllegalArgumentException
- ifbound
is not positive
nextDouble
public double nextDouble(double origin, double bound)
Returns a pseudorandomdouble
value between the specified origin (inclusive) and bound (exclusive).- Parameters:
-
origin
- the least value returned -
bound
- the upper bound (exclusive) - Returns:
-
a pseudorandom
double
value between the origin (inclusive) and the bound (exclusive) - Throws:
-
IllegalArgumentException
- iforigin
is greater than or equal tobound
nextBoolean
public boolean nextBoolean()
Returns a pseudorandomboolean
value.- Overrides:
-
nextBoolean
in classRandom
- Returns:
-
a pseudorandom
boolean
value
nextFloat
public float nextFloat()
Returns a pseudorandomfloat
value between zero (inclusive) and one (exclusive).
nextGaussian
public double nextGaussian()
Description copied from class:Random
Returns the next pseudorandom, Gaussian ("normally") distributeddouble
value with mean0.0
and standard deviation1.0
from this random number generator's sequence.The general contract of
nextGaussian
is that onedouble
value, chosen from (approximately) the usual normal distribution with mean0.0
and standard deviation1.0
, is pseudorandomly generated and returned.The method
nextGaussian
is implemented by classRandom
as if by a threadsafe version of the following:private double nextNextGaussian; private boolean haveNextNextGaussian = false; public double nextGaussian() { if (haveNextNextGaussian) { haveNextNextGaussian = false; return nextNextGaussian; } else { double v1, v2, s; do { v1 = 2 * nextDouble() - 1; // between -1.0 and 1.0 v2 = 2 * nextDouble() - 1; // between -1.0 and 1.0 s = 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; } }
StrictMath.log
and one call toStrictMath.sqrt
.- Overrides:
-
nextGaussian
in classRandom
- Returns:
-
the next pseudorandom, Gaussian ("normally") distributed
double
value with mean0.0
and standard deviation1.0
from this random number generator's sequence
ints
public IntStream ints(long streamSize)
Returns a stream producing the givenstreamSize
number of pseudorandomint
values.- Overrides:
-
ints
in classRandom
- Parameters:
-
streamSize
- the number of values to generate - Returns:
-
a stream of pseudorandom
int
values - Throws:
-
IllegalArgumentException
- ifstreamSize
is less than zero - Since:
- 1.8
ints
public IntStream ints()
Returns an effectively unlimited stream of pseudorandomint
values.
ints
public IntStream ints(long streamSize, int randomNumberOrigin, int randomNumberBound)
Returns a stream producing the givenstreamSize
number of pseudorandomint
values, each conforming to the given origin (inclusive) and bound (exclusive).- Overrides:
-
ints
in classRandom
- Parameters:
-
streamSize
- the number of values to generate -
randomNumberOrigin
- the origin (inclusive) of each random value -
randomNumberBound
- the bound (exclusive) of each random value - Returns:
-
a stream of pseudorandom
int
values, each with the given origin (inclusive) and bound (exclusive) - Throws:
-
IllegalArgumentException
- ifstreamSize
is less than zero, orrandomNumberOrigin
is greater than or equal torandomNumberBound
- Since:
- 1.8
ints
public IntStream ints(int randomNumberOrigin, int randomNumberBound)
Returns an effectively unlimited stream of pseudorandomint
values, each conforming to the given origin (inclusive) and bound (exclusive).- Overrides:
-
ints
in classRandom
- Implementation Note:
-
This method is implemented to be equivalent to
ints(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)
. - Parameters:
-
randomNumberOrigin
- the origin (inclusive) of each random value -
randomNumberBound
- the bound (exclusive) of each random value - Returns:
-
a stream of pseudorandom
int
values, each with the given origin (inclusive) and bound (exclusive) - Throws:
-
IllegalArgumentException
- ifrandomNumberOrigin
is greater than or equal torandomNumberBound
- Since:
- 1.8
longs
public LongStream longs(long streamSize)
Returns a stream producing the givenstreamSize
number of pseudorandomlong
values.- Overrides:
-
longs
in classRandom
- Parameters:
-
streamSize
- the number of values to generate - Returns:
-
a stream of pseudorandom
long
values - Throws:
-
IllegalArgumentException
- ifstreamSize
is less than zero - Since:
- 1.8
longs
public LongStream longs()
Returns an effectively unlimited stream of pseudorandomlong
values.
longs
public LongStream longs(long streamSize, long randomNumberOrigin, long randomNumberBound)
Returns a stream producing the givenstreamSize
number of pseudorandomlong
, each conforming to the given origin (inclusive) and bound (exclusive).- Overrides:
-
longs
in classRandom
- Parameters:
-
streamSize
- the number of values to generate -
randomNumberOrigin
- the origin (inclusive) of each random value -
randomNumberBound
- the bound (exclusive) of each random value - Returns:
-
a stream of pseudorandom
long
values, each with the given origin (inclusive) and bound (exclusive) - Throws:
-
IllegalArgumentException
- ifstreamSize
is less than zero, orrandomNumberOrigin
is greater than or equal torandomNumberBound
- Since:
- 1.8
longs
public LongStream longs(long randomNumberOrigin, long randomNumberBound)
Returns an effectively unlimited stream of pseudorandomlong
values, each conforming to the given origin (inclusive) and bound (exclusive).- Overrides:
-
longs
in classRandom
- Implementation Note:
-
This method is implemented to be equivalent to
longs(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)
. - Parameters:
-
randomNumberOrigin
- the origin (inclusive) of each random value -
randomNumberBound
- the bound (exclusive) of each random value - Returns:
-
a stream of pseudorandom
long
values, each with the given origin (inclusive) and bound (exclusive) - Throws:
-
IllegalArgumentException
- ifrandomNumberOrigin
is greater than or equal torandomNumberBound
- Since:
- 1.8
doubles
public DoubleStream doubles(long streamSize)
Returns a stream producing the givenstreamSize
number of pseudorandomdouble
values, each between zero (inclusive) and one (exclusive).- Overrides:
-
doubles
in classRandom
- Parameters:
-
streamSize
- the number of values to generate - Returns:
-
a stream of
double
values - Throws:
-
IllegalArgumentException
- ifstreamSize
is less than zero - Since:
- 1.8
doubles
public DoubleStream doubles()
Returns an effectively unlimited stream of pseudorandomdouble
values, each between zero (inclusive) and one (exclusive).
doubles
public DoubleStream doubles(long streamSize, double randomNumberOrigin, double randomNumberBound)
Returns a stream producing the givenstreamSize
number of pseudorandomdouble
values, each conforming to the given origin (inclusive) and bound (exclusive).- Overrides:
-
doubles
in classRandom
- Parameters:
-
streamSize
- the number of values to generate -
randomNumberOrigin
- the origin (inclusive) of each random value -
randomNumberBound
- the bound (exclusive) of each random value - Returns:
-
a stream of pseudorandom
double
values, each with the given origin (inclusive) and bound (exclusive) - Throws:
-
IllegalArgumentException
- ifstreamSize
is less than zero -
IllegalArgumentException
- ifrandomNumberOrigin
is greater than or equal torandomNumberBound
- Since:
- 1.8
doubles
public DoubleStream doubles(double randomNumberOrigin, double randomNumberBound)
Returns an effectively unlimited stream of pseudorandomdouble
values, each conforming to the given origin (inclusive) and bound (exclusive).- Overrides:
-
doubles
in classRandom
- Implementation Note:
-
This method is implemented to be equivalent to
doubles(Long.MAX_VALUE, randomNumberOrigin, randomNumberBound)
. - Parameters:
-
randomNumberOrigin
- the origin (inclusive) of each random value -
randomNumberBound
- the bound (exclusive) of each random value - Returns:
-
a stream of pseudorandom
double
values, each with the given origin (inclusive) and bound (exclusive) - Throws:
-
IllegalArgumentException
- ifrandomNumberOrigin
is greater than or equal torandomNumberBound
- Since:
- 1.8
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.