org.jenetics.util

Class LCG64ShiftRandom.ThreadSafe

java.lang.Object

java.util.Random

org.jenetics.util.Random64

org.jenetics.util.LCG64ShiftRandom

org.jenetics.util.LCG64ShiftRandom.ThreadSafe

All Implemented Interfaces:

Serializable

Enclosing class:

LCG64ShiftRandom

public static final class LCG64ShiftRandom.ThreadSafe
extends LCG64ShiftRandom

This is a thread safe variation of the this PRNG—by synchronizing the random number generation.

Since:

1.1

Version:

3.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jenetics.util.LCG64ShiftRandom

LCG64ShiftRandom.Param, LCG64ShiftRandom.ThreadLocal, LCG64ShiftRandom.ThreadSafe

Constructor Summary

Constructors

Constructor and Description
ThreadSafe() Create a new PRNG instance with LCG64ShiftRandom.Param.DEFAULT parameter and a safe seed.
ThreadSafe(LCG64ShiftRandom.Param param) Create a new PRNG instance with the given parameter and a safe default seed.
ThreadSafe(long seed) Create a new PRNG instance with LCG64ShiftRandom.Param.DEFAULT parameter and the given seed.
ThreadSafe(long seed, LCG64ShiftRandom.Param param) Create a new PRNG instance with the given parameter and seed.

Method Summary

Modifier and Type	Method and Description
void	jump(long step) Changes the internal state of the PRNG in such a way that the engine jumps s steps ahead.
void	jump2(int s) Changes the internal state of the PRNG in such a way that the engine jumps 2s steps ahead.
double	nextDouble(double min, double max) Returns a pseudorandom, uniformly distributed double value between min (inclusively) and max (exclusively).
float	nextFloat(float min, float max) Returns a pseudorandom, uniformly distributed double value between min (inclusively) and max (exclusively).
int	nextInt(int min, int max) Returns a pseudorandom, uniformly distributed int value between min and max (end points included).
long	nextLong() Force to explicitly override the Random.nextLong() method.
long	nextLong(long n) Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from the given random number generator's sequence.
long	nextLong(long min, long max) Returns a pseudorandom, uniformly distributed int value between min and max (end points included).
void	setSeed(long seed)
void	split(int p, int s) Changes the internal state of the PRNG in a way that future calls to LCG64ShiftRandom.nextLong() will generated the sth sub-stream of pth sub-streams.

Methods inherited from class org.jenetics.util.LCG64ShiftRandom

equals, getParam, hashCode, toString

Methods inherited from class org.jenetics.util.Random64

next, nextBoolean, nextBytes, nextDouble, nextFloat, nextInt, of

Methods inherited from class java.util.Random

doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, nextGaussian, nextInt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ThreadSafe

public ThreadSafe(long seed,
                  LCG64ShiftRandom.Param param)

Create a new PRNG instance with the given parameter and seed.

Parameters:

seed - the seed of the PRNG.

param - the parameter of the PRNG.

Throws:

NullPointerException - if the given param is null.

ThreadSafe

public ThreadSafe(long seed)

Create a new PRNG instance with LCG64ShiftRandom.Param.DEFAULT parameter and the given seed.

Parameters:

seed - the seed of the PRNG

ThreadSafe

public ThreadSafe(LCG64ShiftRandom.Param param)

Create a new PRNG instance with the given parameter and a safe default seed.

Parameters:

param - the PRNG parameter.

Throws:

NullPointerException - if the given param is null.

ThreadSafe

public ThreadSafe()

Create a new PRNG instance with LCG64ShiftRandom.Param.DEFAULT parameter and a safe seed.

Method Detail

setSeed

public void setSeed(long seed)

Overrides:

setSeed in class LCG64ShiftRandom

nextLong

public long nextLong()

Description copied from class: Random64

Force to explicitly override the Random.nextLong() method. All other methods of this class are implemented by calling this method.

Overrides:

nextLong in class LCG64ShiftRandom

split

public void split(int p,
                  int s)

Description copied from class: LCG64ShiftRandom

Changes the internal state of the PRNG in a way that future calls to LCG64ShiftRandom.nextLong() will generated the s^th sub-stream of p^th sub-streams. s must be within the range of [0, p-1). This method is mainly used for parallelization via leap-frogging.

Overrides:

split in class LCG64ShiftRandom

Parameters:

p - the overall number of sub-streams

s - the s^th sub-stream

jump2

public void jump2(int s)

Description copied from class: LCG64ShiftRandom

Changes the internal state of the PRNG in such a way that the engine jumps 2^s steps ahead.

Overrides:

jump2 in class LCG64ShiftRandom

Parameters:

s - the 2^s steps to jump ahead.

jump

public void jump(long step)

Description copied from class: LCG64ShiftRandom

Changes the internal state of the PRNG in such a way that the engine jumps s steps ahead.

Overrides:

jump in class LCG64ShiftRandom

Parameters:

step - the steps to jump ahead.

nextInt

public int nextInt(int min,
                   int max)

Returns a pseudorandom, uniformly distributed int value between min and max (end points included).

Parameters:

min - lower bound for generated integer (inclusively)

max - upper bound for generated integer (inclusively)

Returns:

a random integer greater than or equal to min and less than or equal to max

Throws:

IllegalArgumentException - if min >= max

See Also:

random.nextInt(java.util.Random, int, int)

nextLong

public long nextLong(long min,
                     long max)

Returns a pseudorandom, uniformly distributed int value between min and max (end points included).

Parameters:

min - lower bound for generated long integer (inclusively)

max - upper bound for generated long integer (inclusively)

Returns:

a random long integer greater than or equal to min and less than or equal to max

Throws:

IllegalArgumentException - if min >= max

See Also:

random.nextLong(java.util.Random, long, long)

nextLong

public long nextLong(long n)

Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from the given random number generator's sequence.

Parameters:

n - the bound on the random number to be returned. Must be positive.

Returns:

the next pseudorandom, uniformly distributed int value between 0 (inclusive) and n (exclusive) from the given random number generator's sequence

Throws:

IllegalArgumentException - if n is smaller than 1.

See Also:

random.nextLong(java.util.Random, long)

nextFloat

public float nextFloat(float min,
                       float max)

Returns a pseudorandom, uniformly distributed double value between min (inclusively) and max (exclusively).

Parameters:

min - lower bound for generated float value (inclusively)

max - upper bound for generated float value (exclusively)

Returns:

a random float greater than or equal to min and less than to max

See Also:

random.nextFloat(java.util.Random, float, float)

nextDouble

public double nextDouble(double min,
                         double max)

Returns a pseudorandom, uniformly distributed double value between min (inclusively) and max (exclusively).

Parameters:

min - lower bound for generated double value (inclusively)

max - upper bound for generated double value (exclusively)

Returns:

a random double greater than or equal to min and less than to max

See Also:

random.nextDouble(java.util.Random, double, double)