jdk.util.concurrent.ThreadLocalRandom — clojure-interop/java.util.concurrent 1.0.0

A random number generator isolated to the current thread. Like the global Random generator used by the Math class, a ThreadLocalRandom is initialized with an internally generated seed that may not otherwise be modified. When applicable, use of ThreadLocalRandom rather than shared Random objects in concurrent programs will typically encounter much less overhead and contention. Use of ThreadLocalRandom is particularly appropriate when multiple tasks (for example, each a ForkJoinTask) use random numbers in parallel in thread pools.

Usages of this class should typically be of the form: ThreadLocalRandom.current().nextX(...) (where X is Int, Long, etc). When all usages are of this form, it is never possible to accidently share a ThreadLocalRandom across multiple threads.

This class also provides additional commonly used bounded random generation methods.

Instances of ThreadLocalRandom are not cryptographically secure. Consider instead using SecureRandom in security-sensitive applications. Additionally, default-constructed instances do not use a cryptographically random seed unless the system property java.util.secureRandomSeed is set to true.

*current clj

(*current)

Returns the current thread's ThreadLocalRandom.

returns: the current thread's ThreadLocalRandom - java.util.con.ThreadLocalRandom

doubles clj

(doubles this)

(doubles this stream-size)

(doubles this random-number-origin random-number-bound)

(doubles this stream-size random-number-origin random-number-bound)

Returns a stream producing the given streamSize number of pseudorandom double values, each conforming to the given origin (inclusive) and bound (exclusive).

stream-size - the number of values to generate - long random-number-origin - the origin (inclusive) of each random value - double random-number-bound - the bound (exclusive) of each random value - double

returns: a stream of pseudorandom double values, each with the given origin (inclusive) and bound (exclusive) - java.util.stream.DoubleStream

throws: java.lang.IllegalArgumentException - if randomNumberOrigin is greater than or equal to randomNumberBound

ints clj

(ints this)

(ints this stream-size)

(ints this random-number-origin random-number-bound)

(ints this stream-size random-number-origin random-number-bound)

Returns a stream producing the given streamSize number of pseudorandom int values, each conforming to the given origin (inclusive) and bound (exclusive).

stream-size - the number of values to generate - long random-number-origin - the origin (inclusive) of each random value - int random-number-bound - the bound (exclusive) of each random value - int

returns: a stream of pseudorandom int values, each with the given origin (inclusive) and bound (exclusive) - java.util.stream.IntStream

throws: java.lang.IllegalArgumentException - if streamSize is less than zero, or randomNumberOrigin is greater than or equal to randomNumberBound

longs clj

(longs this)

(longs this stream-size)

(longs this random-number-origin random-number-bound)

(longs this stream-size random-number-origin random-number-bound)

Returns a stream producing the given streamSize number of pseudorandom long, each conforming to the given origin (inclusive) and bound (exclusive).

stream-size - the number of values to generate - long random-number-origin - the origin (inclusive) of each random value - long random-number-bound - the bound (exclusive) of each random value - long

returns: a stream of pseudorandom long values, each with the given origin (inclusive) and bound (exclusive) - java.util.stream.LongStream

throws: java.lang.IllegalArgumentException - if streamSize is less than zero, or randomNumberOrigin is greater than or equal to randomNumberBound

next-boolean clj

(next-boolean this)

Returns a pseudorandom boolean value.

returns: a pseudorandom boolean value - boolean

next-double clj

(next-double this)

(next-double this bound)

(next-double this origin bound)

Returns a pseudorandom double value between the specified origin (inclusive) and bound (exclusive).

origin - the least value returned - double bound - the upper bound (exclusive) - double

returns: a pseudorandom double value between the origin (inclusive) and the bound (exclusive) - double

throws: java.lang.IllegalArgumentException - if origin is greater than or equal to bound

next-float clj

(next-float this)

Returns a pseudorandom float value between zero (inclusive) and one (exclusive).

returns: a pseudorandom float value between zero (inclusive) and one (exclusive) - float

next-gaussian clj

(next-gaussian this)

Description copied from class: Random

returns: the next pseudorandom, Gaussian (normally) distributed double value with mean 0.0 and standard deviation 1.0 from this random number generator's sequence - double

next-int clj

(next-int this)

(next-int this bound)

(next-int this origin bound)

Returns a pseudorandom int value between the specified origin (inclusive) and the specified bound (exclusive).

origin - the least value returned - int bound - the upper bound (exclusive) - int

returns: a pseudorandom int value between the origin (inclusive) and the bound (exclusive) - int

throws: java.lang.IllegalArgumentException - if origin is greater than or equal to bound

next-long clj

(next-long this)

(next-long this bound)

(next-long this origin bound)

Returns a pseudorandom long value between the specified origin (inclusive) and the specified bound (exclusive).

origin - the least value returned - long bound - the upper bound (exclusive) - long

returns: a pseudorandom long value between the origin (inclusive) and the bound (exclusive) - long

throws: java.lang.IllegalArgumentException - if origin is greater than or equal to bound

set-seed clj

(set-seed this seed)

Throws UnsupportedOperationException. Setting seeds in this generator is not supported.

seed - the initial seed - long

throws: java.lang.UnsupportedOperationException - always