This class implements the RandomStream interface via inheritance from RandomStreamBase. More...

Inheritance diagram for umontreal.ssj.rng.WELL512:

Public Member Functions
	WELL512 ()
	Constructs a new stream.
	WELL512 (String name)
	Constructs a new stream with the identifier name (used in the toString method).
void	setSeed (int seed[])
	This method is discouraged for normal use.
int[]	getState ()
	Returns the current state of the stream, represented as an array of 16 integers.
WELL512	clone ()
	Clones the current generator and return its copy.
void	resetStartStream ()
	Reinitializes the stream to its initial state \(I_g\): \(C_g\) and \(B_g\) are set to \(I_g\).
void	resetStartSubstream ()
	Reinitializes the stream to the beginning of its current substream:
void	resetNextSubstream ()
	Reinitializes the stream to the beginning of its next substream:
String	toString ()
	Returns a string containing the current state of this stream.
Public Member Functions inherited from umontreal.ssj.rng.RandomStreamBase
void	increasedPrecision (boolean incp)
	After calling this method with incp = true, each call to the RNG (direct or indirect) for this stream will return a uniform random number with more bits of precision than what is returned by nextValue, and will advance the state of the stream by 2 steps instead of 1 (i.e., nextValue will be called twice for each random number).
double	nextDouble ()
	Returns a uniform random number between 0 and 1 from the stream.
void	nextArrayOfDouble (double[] u, int start, int n)
	Calls nextDouble n times to fill the array u.
int	nextInt (int i, int j)
	Calls nextDouble once to create one integer between i and j.
void	nextArrayOfInt (int i, int j, int[] u, int start, int n)
	Calls nextInt n times to fill the array u.
String	formatState ()
	Use the toString method.
String	formatStateFull ()
	Use the toStringFull method.

Static Public Member Functions
static void	setPackageSeed (int seed[])
	Sets the initial seed of the class WELL512 to the 16 integers of the vector seed[0..15].

Protected Member Functions
double	nextValue ()
	This method should return the next random number (between 0 and 1) from the current stream.

Detailed Description

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 in [192], [193] , and which has a state size of 512 bits and a period length of \(\rho\approx\) \(2^{512}\). The values of \(V\), \(W\) and \(Z\) are \(2^{150}\), \(2^{200}\) and \(2^{350}\) 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.

Definition at line 45 of file WELL512.java.

Constructor & Destructor Documentation

◆ WELL512() [1/2]

umontreal.ssj.rng.WELL512.WELL512 ( )

Constructs a new stream.

Definition at line 139 of file WELL512.java.

◆ WELL512() [2/2]

umontreal.ssj.rng.WELL512.WELL512 ( String name )

Constructs a new stream with the identifier name (used in the toString method).

Parameters

name	name of the stream

Definition at line 157 of file WELL512.java.

Member Function Documentation

◆ clone()

WELL512 umontreal.ssj.rng.WELL512.clone ( )

Clones the current generator and return its copy.

Returns: A deep copy of the current generator

Reimplemented from umontreal.ssj.rng.RandomStreamBase.

Definition at line 212 of file WELL512.java.

◆ getState()

int[] umontreal.ssj.rng.WELL512.getState ( )

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

Returns: the current state of the stream

Definition at line 200 of file WELL512.java.

◆ nextValue()

double umontreal.ssj.rng.WELL512.nextValue ( )

protected

This method should return the next random number (between 0 and 1) from the current stream.

If the stream is set to the high precision mode (increasedPrecision(true) was called), then each call to nextDouble will call nextValue twice, otherwise it will call it only once.

Returns: a number in the interval (0,1)

Reimplemented from umontreal.ssj.rng.RandomStreamBase.

Definition at line 259 of file WELL512.java.

◆ resetNextSubstream()

void umontreal.ssj.rng.WELL512.resetNextSubstream ( )

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\).

Reimplemented from umontreal.ssj.rng.RandomStreamBase.

Definition at line 240 of file WELL512.java.

◆ resetStartStream()

void umontreal.ssj.rng.WELL512.resetStartStream ( )

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

Reimplemented from umontreal.ssj.rng.RandomStreamBase.

Definition at line 228 of file WELL512.java.

◆ resetStartSubstream()

void umontreal.ssj.rng.WELL512.resetStartSubstream ( )

Reinitializes the stream to the beginning of its current substream:

\(C_g\) is set to \(B_g\).

Reimplemented from umontreal.ssj.rng.RandomStreamBase.

Definition at line 234 of file WELL512.java.

◆ setPackageSeed()

void umontreal.ssj.rng.WELL512.setPackageSeed ( int seed[] )

static

Sets the initial seed of the class WELL512 to the 16 integers of the vector seed[0..15].

This will be the initial seed of the class of the next created stream. At least one of the integers must be non-zero.

Parameters

seed	array of 16 elements representing the seed

Definition at line 169 of file WELL512.java.

◆ setSeed()

void umontreal.ssj.rng.WELL512.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..15]. The seed must satisfy the same conditions as in setPackageSeed. This method only affects the specified stream; the others are not modified. Hence after calling this method, the beginning of the streams will no longer 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 16 elements representing the seed

Definition at line 187 of file WELL512.java.

◆ toString()

String umontreal.ssj.rng.WELL512.toString ( )

Returns a string containing the current state of this stream.

Returns: the state of the generator formated as a string

Reimplemented from umontreal.ssj.rng.RandomStreamBase.

Definition at line 245 of file WELL512.java.

The documentation for this class was generated from the following file:

src/main/java/umontreal/ssj/rng/WELL512.java

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WELL512() [1/2]

◆ WELL512() [2/2]

Member Function Documentation

◆ clone()

◆ getState()

◆ nextValue()

◆ resetNextSubstream()

◆ resetStartStream()

◆ resetStartSubstream()

◆ setPackageSeed()

◆ setSeed()

◆ toString()