umontreal.iro.lecuyer.rng

Class LFSR113

java.lang.Object

umontreal.iro.lecuyer.rng.RandomStreamBase

umontreal.iro.lecuyer.rng.LFSR113

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, CloneableRandomStream, RandomStream

public class LFSR113
extends RandomStreamBase

Extends RandomStreamBase using a composite linear feedback shift register (LFSR) (or Tausworthe) RNG as defined in. This generator is the LFSR113 proposed by. It has four 32-bit components combined by a bitwise xor. Its period length is approximatively 2^113 . The values of V, W and Z are 2³⁵, 2⁵⁵ and 2⁹⁰ respectively (see RandomStream for their definition). The seed of the RNG, and the state of a stream at any given step, are four-dimensional vectors of 32-bit integers. The default initial seed of the RNG is (12345, 12345, 12345, 12345). The nextValue method returns numbers with 32 bits of precision.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LFSR113() Constructs a new stream.
LFSR113(java.lang.String name) Constructs a new stream with the identifier name.

Method Summary

Methods

Modifier and Type	Method and Description
LFSR113	clone() Clones the current generator and return its copy.
int[]	getState() Returns the current state of the stream, represented as an array of four integers.
int	nextInt(int i, int j) Calls nextDouble once to create one integer between i and j.
void	resetNextSubstream() Reinitializes the stream to the beginning of its next substream: Ng is computed, and Cg and Bg are set to Ng.
void	resetStartStream() Reinitializes the stream to its initial state Ig: Cg and Bg are set to Ig.
void	resetStartSubstream() Reinitializes the stream to the beginning of its current substream: Cg is set to Bg.
static void	setPackageSeed(int[] seed) Sets the initial seed for the class LFSR113 to the four integers of the vector seed[0..3].
void	setSeed(int[] seed) This method is discouraged for normal use.
java.lang.String	toString() Returns a string containing the current state of this stream.

Methods inherited from class umontreal.iro.lecuyer.rng.RandomStreamBase

formatState, formatStateFull, increasedPrecision, nextArrayOfDouble, nextArrayOfInt, nextDouble

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LFSR113

public LFSR113()

Constructs a new stream.

LFSR113

public LFSR113(java.lang.String name)

Constructs a new stream with the identifier name.

Parameters:

name - name of the stream

Method Detail

setPackageSeed

public static void setPackageSeed(int[] seed)

Sets the initial seed for the class LFSR113 to the four integers of the vector seed[0..3]. This will be the initial state (or seed) of the next created stream. The default seed for the first stream is (12345, 12345, 12345, 12345). The first, second, third and fourth integers of seed must be either negative, or greater than or equal to 2, 8, 16 and 128 respectively.

Parameters:

seed - array of 4 elements representing the seed

setSeed

public void setSeed(int[] seed)

This method is discouraged for normal use. Initializes the stream at the beginning of a stream with the initial seed seed[0..3]. The seed must satisfy the same conditions as in setPackageSeed. This method only affects the specified stream; the others are not modified, so the beginning of the streams will not be spaced Z values apart. For this reason, this method should only be used in very exceptional cases; proper use of the reset... methods and of the stream constructor is preferable.

Parameters:

seed - array of 4 elements representing the seed

getState

public int[] getState()

Returns the current state of the stream, represented as an array of four integers.

Returns:

the current state of the stream

clone

public LFSR113 clone()

Clones the current generator and return its copy.

Specified by:

clone in interface CloneableRandomStream

Overrides:

clone in class RandomStreamBase

Returns:

A deep copy of the current generator

resetStartStream

public void resetStartStream()

Description copied from interface: RandomStream

Reinitializes the stream to its initial state I_g: C_g and B_g are set to I_g.

Specified by:

resetStartStream in interface RandomStream

Specified by:

resetStartStream in class RandomStreamBase

resetStartSubstream

public void resetStartSubstream()

Description copied from interface: RandomStream

Reinitializes the stream to the beginning of its current substream: C_g is set to B_g.

Specified by:

resetStartSubstream in interface RandomStream

Specified by:

resetStartSubstream in class RandomStreamBase

resetNextSubstream

public void resetNextSubstream()

Description copied from interface: RandomStream

Reinitializes the stream to the beginning of its next substream: N_g is computed, and C_g and B_g are set to N_g.

Specified by:

resetNextSubstream in interface RandomStream

Specified by:

resetNextSubstream in class RandomStreamBase

toString

public java.lang.String toString()

Description copied from interface: RandomStream

Returns a string containing the current state of this stream.

Specified by:

toString in interface RandomStream

Specified by:

toString in class RandomStreamBase

Returns:

the state of the generator formated as a string

nextInt

public int nextInt(int i,
          int j)

Description copied from class: RandomStreamBase

Calls nextDouble once to create one integer between i and j. This method always uses the highest order bits of the random number. It should be overridden if a faster implementation exists for the specific generator.

Specified by:

nextInt in interface RandomStream

Overrides:

nextInt in class RandomStreamBase

Parameters:

i - the smallest possible returned integer

j - the largest possible returned integer

Returns:

a random integer between i and j