Summary: Methods | Inherited Methods

RandomGeneratorFactory

public final class RandomGeneratorFactory
extends Object

java.lang.Object
↳	java.util.random.RandomGeneratorFactory<T extends java.util.random.RandomGenerator>

This is a factory class for generating multiple random number generators of a specific algorithm. RandomGeneratorFactory also provides methods for selecting random number generator algorithms. A specific RandomGeneratorFactory can be located by using the RandomGeneratorFactory#of(String) method, where the argument string is the name of the algorithm required. The method RandomGeneratorFactory#all() produces a non-empty Stream of all available RandomGeneratorFactorys that can be searched to locate a RandomGeneratorFactory suitable to the task. There are three methods for constructing a RandomGenerator instance, depending on the type of initial seed required. RandomGeneratorFactory#create(long) is used for long seed construction, RandomGeneratorFactory#create(byte[]) is used for byte[] seed construction, and RandomGeneratorFactory#create() is used for random seed construction. Example;

RandomGeneratorFactory<RandomGenerator> factory = RandomGeneratorFactory.of("Random");

     for (int i = 0; i < 10; i++) {
         new Thread(() -> {
             RandomGenerator random = factory.create(100L);
             System.out.println(random.nextDouble());
         }).start();
     }

RandomGeneratorFactory also provides methods describing the attributes (or properties) of a generator and can be used to select random number generator algorithms. These methods are typically used in conjunction with RandomGeneratorFactory#all(). In this example, the code locates the RandomGeneratorFactory that produces RandomGenerators with the highest number of state bits.

RandomGeneratorFactory<RandomGenerator> best = RandomGeneratorFactory.all()
         .sorted(Comparator.comparingInt(RandomGenerator::stateBits).reversed())
         .findFirst()
         .orElse(RandomGeneratorFactory.of("Random"));
     System.out.println(best.name() + " in " + best.group() + " was selected");

     RandomGenerator rng = best.create();
     System.out.println(rng.nextLong());

See also:

java.util.random

Summary

Public methods
`static Stream<RandomGeneratorFactory<RandomGenerator>>`	`all()` Returns a non-empty stream of available `RandomGeneratorFactory(s)`.
`T`	`create(byte[] seed)` Create an instance of `RandomGenerator` based on algorithm chosen providing a starting byte[] seed.
`T`	`create(long seed)` Create an instance of `RandomGenerator` based on algorithm chosen providing a starting long seed.
`T`	`create()` Create an instance of `RandomGenerator` based on algorithm chosen.
`int`	`equidistribution()` Returns the equidistribution of the algorithm.
`static RandomGeneratorFactory<RandomGenerator>`	`getDefault()` Returns a `RandomGeneratorFactory` meeting the minimal requirement of having an algorithm whose state bits are greater than or equal 64.
`String`	`group()` Return the group name of the algorithm used by the random number generator.
`boolean`	`isArbitrarilyJumpable()` Return true if random generator can jump an arbitrarily specified distant point in the state cycle.
`boolean`	`isDeprecated()` Return true if the implementation of RandomGenerator (algorithm) has been marked for deprecation.
`boolean`	`isHardware()` Return true if random generator uses a hardware device (HRNG) to produce entropic input.
`boolean`	`isJumpable()` Return true if random generator can jump a specified distant point in the state cycle.
`boolean`	`isLeapable()` Return true if random generator is jumpable and can leap to a very distant point in the state cycle.
`boolean`	`isSplittable()` Return true if random generator can be cloned into a separate object with the same properties but positioned further in the state cycle.
`boolean`	`isStatistical()` Return true if random generator is computed using an arithmetic algorithm and is statistically deterministic.
`boolean`	`isStochastic()` Return true if random generator is computed using external or entropic sources as inputs.
`boolean`	`isStreamable()` Return true if random generator can be used to create `Streams` of random numbers.
`String`	`name()` Return the name of the algorithm used by the random number generator.
`static <T extends RandomGenerator> RandomGeneratorFactory<T>`	`of(String name)` Returns a `RandomGeneratorFactory` that can produce instances of `RandomGenerator` that utilize the `name` algorithm.
`BigInteger`	`period()` Return the period of the algorithm used by the random number generator.
`int`	`stateBits()` Returns number of bits used by the algorithm to maintain state of seed.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Throws
`NullPointerException`	if name is null
`IllegalArgumentException`	if the named algorithm is not found

RandomGeneratorFactory

Summary

Public methods

Inherited methods

Public methods

all

Implementation Requirements:

create

create

create

equidistribution

getDefault

Implementation Requirements:

group

isArbitrarilyJumpable

isDeprecated

Implementation Note:

isHardware

isJumpable

isLeapable

isSplittable

isStatistical

isStochastic

isStreamable

name

of

Implementation Requirements:

period

stateBits