Package io.github.pr0methean.betterrandom.prng.adapter

Class BaseSplittableRandomAdapter

java.lang.Object

java.util.Random

io.github.pr0methean.betterrandom.prng.BaseRandom

io.github.pr0methean.betterrandom.prng.adapter.BaseSplittableRandomAdapter

All Implemented Interfaces:

ByteArrayReseedableRandom, EntropyCountingRandom, Java8CompatRandom, RepeatableRandom, Dumpable, Serializable

Direct Known Subclasses:

DirectSplittableRandomAdapter, SplittableRandomAdapter

public abstract class BaseSplittableRandomAdapter
extends BaseRandom

Abstract class for implementations of BaseRandom that wrap one or more SplittableRandom instances.

Author:

Chris Hennick

See Also:

Serialized Form

Field Summary

Fields inherited from class io.github.pr0methean.betterrandom.prng.BaseRandom

ENTROPY_OF_DOUBLE, ENTROPY_OF_FLOAT, entropyBits, lock, randomSeeder, seed, superConstructorFinished

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseSplittableRandomAdapter(byte[] seed)	Constructs an instance with the given seed.
protected	BaseSplittableRandomAdapter(long seed)	Constructs an instance with the given seed.

Method Summary

Modifier and Type	Method	Description
int	getNewSeedLength()	Returns the only supported seed length.
protected abstract java8.util.SplittableRandom	getSplittableRandom()	Returns the SplittableRandom that is to be used to generate random numbers for the current thread.
protected void	lockForNextGaussian()	Performs whatever locking is needed by BaseRandom.nextGaussian().
protected int	next(int bits)	Delegates to SplittableRandom.nextInt() or SplittableRandom.nextInt(int).
boolean	nextBoolean()	Delegates to SplittableRandom.nextBoolean().
void	nextBytes(byte[] bytes)	Delegates to SplittableRandom.nextInt(256).
double	nextDouble(double bound)	Delegates to SplittableRandom.nextDouble(bound).
double	nextDouble(double origin, double bound)	Delegates to SplittableRandom.nextDouble (origin, bound).
protected double	nextDoubleNoEntropyDebit()	Delegates to SplittableRandom.nextDouble().
float	nextFloat()	Delegates to SplittableRandom.nextInt(int).
double	nextGaussian()	Delegates to SplittableRandom.nextDouble() via BaseRandom.internalNextGaussian(DoubleSupplier).
int	nextInt()	Delegates to SplittableRandom.nextInt().
int	nextInt(int bound)	Delegates to SplittableRandom.nextInt(bound).
int	nextInt(int origin, int bound)	Delegates to SplittableRandom.nextInt(origin, bound).
long	nextLong(long bound)	Delegates to SplittableRandom.nextLong(bound).
long	nextLong(long origin, long bound)	Delegates to SplittableRandom.nextLong(origin, bound).
protected long	nextLongNoEntropyDebit()	Delegates to SplittableRandom.nextLong().
boolean	preferSeedWithLong()	Indicates whether Random.setSeed(long) is recommended over ByteArrayReseedableRandom.setSeed(byte[]) when the seed is already in the form of a long.
protected void	unlockForNextGaussian()	Releases the locks acquired by BaseRandom.lockForNextGaussian().
protected boolean	withProbabilityInternal(double probability)	Delegates to SplittableRandom.nextDouble().

Methods inherited from class io.github.pr0methean.betterrandom.prng.BaseRandom

addSubclassFields, checkLength, creditEntropyForNewSeed, debitEntropy, doubles, doubles, doubles, doubles, dump, entropyOfInt, entropyOfLong, fallbackSetSeedIfInitialized, gaussians, gaussians, getEntropyBits, getRandomSeeder, getSeed, initTransientFields, internalNextGaussian, ints, ints, ints, ints, longs, longs, longs, longs, needsReseedingEarly, nextDouble, nextElement, nextElement, nextEnum, nextLong, setRandomSeeder, setSeed, setSeed, setSeedInternal, supportsMultipleSeedLengths, usesParallelStreams, withProbability

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseSplittableRandomAdapter

protected BaseSplittableRandomAdapter(byte[] seed)

Constructs an instance with the given seed.

Parameters:

seed - The seed.

BaseSplittableRandomAdapter

protected BaseSplittableRandomAdapter(long seed)

Constructs an instance with the given seed.

Parameters:

seed - The seed.

Method Detail

getSplittableRandom

protected abstract java8.util.SplittableRandom getSplittableRandom()

Returns the SplittableRandom that is to be used to generate random numbers for the current thread. (SplittableRandom isn't thread-safe.) Called by all the next* methods.

Returns:

the SplittableRandom to use with the current thread.

nextDouble

public double nextDouble(double bound)

Delegates to SplittableRandom.nextDouble(bound).

Overrides:

nextDouble in class BaseRandom

Parameters:

bound - the upper bound (exclusive). Must be positive.

Returns:

a pseudorandom double value between zero (inclusive) and the bound (exclusive)

nextDouble

public double nextDouble(double origin,
                         double bound)

Delegates to SplittableRandom.nextDouble (origin, bound).

Overrides:

nextDouble in class BaseRandom

Parameters:

origin - the least value returned

bound - the upper bound (exclusive)

Returns:

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

next

protected int next(int bits)

Delegates to SplittableRandom.nextInt() or SplittableRandom.nextInt(int).

Specified by:

next in class BaseRandom

nextBytes

public void nextBytes(byte[] bytes)

Delegates to SplittableRandom.nextInt(256).

Specified by:

nextBytes in interface Java8CompatRandom

Overrides:

nextBytes in class BaseRandom

nextInt

public int nextInt()

Delegates to SplittableRandom.nextInt().

Specified by:

nextInt in interface Java8CompatRandom

Overrides:

nextInt in class BaseRandom

nextInt

public int nextInt(int bound)

Delegates to SplittableRandom.nextInt(bound).

Specified by:

nextInt in interface Java8CompatRandom

Overrides:

nextInt in class BaseRandom

nextInt

public int nextInt(int origin,
                   int bound)

Delegates to SplittableRandom.nextInt(origin, bound).

Overrides:

nextInt in class BaseRandom

Parameters:

origin - the least value returned

bound - the upper bound (exclusive)

Returns:

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

withProbabilityInternal

protected boolean withProbabilityInternal(double probability)

Delegates to SplittableRandom.nextDouble().

Called by BaseRandom.withProbability(double) to generate a boolean with a specified probability of returning true, after checking that probability is strictly between 0 and 1.

Overrides:

withProbabilityInternal in class BaseRandom

Parameters:

probability - The probability (between 0 and 1 exclusive) of returning true.

Returns:

True with probability equal to the probability parameter; false otherwise.

preferSeedWithLong

public boolean preferSeedWithLong()

Description copied from interface: ByteArrayReseedableRandom

Indicates whether Random.setSeed(long) is recommended over ByteArrayReseedableRandom.setSeed(byte[]) when the seed is already in the form of a long.

Specified by:

preferSeedWithLong in interface ByteArrayReseedableRandom

Overrides:

preferSeedWithLong in class BaseRandom

Returns:

true if Random.setSeed(long) will tend to perform better than ByteArrayReseedableRandom.setSeed(byte[]).

nextLongNoEntropyDebit

protected long nextLongNoEntropyDebit()

Delegates to SplittableRandom.nextLong().

Returns the next random long, but does not debit entropy.

Overrides:

nextLongNoEntropyDebit in class BaseRandom

Returns:

a pseudorandom long with all possible values equally likely.

nextLong

public long nextLong(long bound)

Delegates to SplittableRandom.nextLong(bound).

Overrides:

nextLong in class BaseRandom

Parameters:

bound - the upper bound (exclusive). Must be positive.

Returns:

a pseudorandom long value between zero (inclusive) and the bound (exclusive)

nextLong

public long nextLong(long origin,
                     long bound)

Delegates to SplittableRandom.nextLong(origin, bound).

Overrides:

nextLong in class BaseRandom

Parameters:

origin - the least value returned

bound - the upper bound (exclusive)

Returns:

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

nextDoubleNoEntropyDebit

protected double nextDoubleNoEntropyDebit()

Delegates to SplittableRandom.nextDouble().

Overrides:

nextDoubleNoEntropyDebit in class BaseRandom

Returns:

a pseudorandom double.

nextGaussian

public double nextGaussian()

Delegates to SplittableRandom.nextDouble() via BaseRandom.internalNextGaussian(DoubleSupplier).

Specified by:

nextGaussian in interface Java8CompatRandom

Overrides:

nextGaussian in class BaseRandom

lockForNextGaussian

protected void lockForNextGaussian()

Description copied from class: BaseRandom

Performs whatever locking is needed by BaseRandom.nextGaussian().

Overrides:

lockForNextGaussian in class BaseRandom

unlockForNextGaussian

protected void unlockForNextGaussian()

Description copied from class: BaseRandom

Releases the locks acquired by BaseRandom.lockForNextGaussian().

Overrides:

unlockForNextGaussian in class BaseRandom

nextBoolean

public boolean nextBoolean()

Delegates to SplittableRandom.nextBoolean().

Specified by:

nextBoolean in interface Java8CompatRandom

Overrides:

nextBoolean in class BaseRandom

nextFloat

public float nextFloat()

Delegates to SplittableRandom.nextInt(int).

Specified by:

nextFloat in interface Java8CompatRandom

Overrides:

nextFloat in class BaseRandom

getNewSeedLength

public int getNewSeedLength()

Returns the only supported seed length.

Specified by:

getNewSeedLength in interface ByteArrayReseedableRandom

Specified by:

getNewSeedLength in class BaseRandom

Returns:

The desired length of a new byte-array seed.