SSJ
V. labo.

umontreal.iro.lecuyer.rng
Class WELL512

java.lang.Object
  extended by umontreal.iro.lecuyer.rng.RandomStreamBase
      extended by umontreal.iro.lecuyer.rng.WELL512
All Implemented Interfaces:
Serializable, Cloneable, CloneableRandomStream, RandomStream

public class WELL512
extends RandomStreamBase

WELL512

This class implements the RandomStream interface via inheritance from RandomStreamBase. The backbone generator is a Well Equidistributed Long period Linear Random Number Generator (WELL), proposed by F. Panneton, and which has a state size of 512 bits and a period length of approximatively 2512. The values of V, W and Z are 2150, 2200 and 2350 respectively (see RandomStream for their definition). The seed of the RNG, and the state of a stream at any given step, is a 16-dimensional vector of 32-bit integers.

See Also:
Serialized Form

Constructor Summary
WELL512()
          .
WELL512(String name)
          .
 
Method Summary
 WELL512 clone()
          .
 int[] getState()
          .
 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)
          .
 void setSeed(int[] seed)
          .
 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, nextInt
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WELL512

public WELL512()
. \begin{tabb}Constructs a new stream.
 \end{tabb}


WELL512

public WELL512(String name)
. \begin{tabb}Constructs a new stream with the identifier \texttt{name}
 (used in the \texttt{toString} method).
 \end{tabb}
namename of the stream

Method Detail

setPackageSeed

public static void setPackageSeed(int[] seed)
. \begin{tabb}Sets the initial seed of the class \texttt{WELL512} to the 16
 integ...
 ... next created stream.
 At least one of the integers must be non-zero.
 \end{tabb}
seedarray of 16 elements representing the seed


setSeed

public void setSeed(int[] seed)
. \begin{tabb}This method is discouraged for normal use.
 Initializes the stream a...
 ...exttt{reset...} methods and of the stream constructor is
 preferable.
 \end{tabb}
seedarray of 16 elements representing the seed


getState

public int[] getState()
. \begin{tabb}Returns the current state of the stream, represented as an
 array of 16 integers.
 \end{tabb}
the current state of the stream


clone

public WELL512 clone()
. \begin{tabb}Clones the current generator and return its copy.
 \end{tabb}
A deep copy of the current generator

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 Ig: Cg and Bg are set to Ig.

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: Cg is set to Bg.

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: Ng is computed, and Cg and Bg are set to Ng.

Specified by:
resetNextSubstream in interface RandomStream
Specified by:
resetNextSubstream in class RandomStreamBase

toString

public 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

SSJ
V. labo.

To submit a bug or ask questions, send an e-mail to Pierre L'Ecuyer.