SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
WELL1024 Class Reference

Implements the RandomStream interface via inheritance from RandomStreamBase. More...

Inheritance diagram for WELL1024:
[legend]
Collaboration diagram for WELL1024:
[legend]

Public Member Functions

 WELL1024 ()
 Constructs a new stream.
 
 WELL1024 (String name)
 Constructs a new stream with the identifier name (used in the toString method). More...
 
void setSeed (int seed[])
 This method is discouraged for normal use. More...
 
int [] getState ()
 Returns the current state of the stream, represented as an array of 32 integers. More...
 
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: \(C_g\) is set to \(B_g\).
 
void 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\).
 
String toString ()
 Returns a string containing the current state of this stream. More...
 
WELL1024 clone ()
 Clones the current generator and return its copy. More...
 
- Public Member Functions inherited from RandomStreamBase
abstract void resetStartStream ()
 Reinitializes the stream to its initial state \(I_g\): \(C_g\) and \(B_g\) are set to \(I_g\).
 
abstract void resetStartSubstream ()
 Reinitializes the stream to the beginning of its current substream: \(C_g\) is set to \(B_g\).
 
abstract void 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\).
 
abstract String toString ()
 Returns a string containing the current state of this stream. More...
 
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). More...
 
double nextDouble ()
 Returns a uniform random number between 0 and 1 from the stream. More...
 
void nextArrayOfDouble (double[] u, int start, int n)
 Calls nextDouble n times to fill the array u. More...
 
int nextInt (int i, int j)
 Calls nextDouble once to create one integer between i and j. More...
 
void nextArrayOfInt (int i, int j, int[] u, int start, int n)
 Calls nextInt n times to fill the array u. More...
 
String formatState ()
 Use the toString method.
 
String formatStateFull ()
 Use the toStringFull method.
 
RandomStreamBase clone ()
 Clones the current generator and return its copy. More...
 

Static Public Member Functions

static void setPackageSeed (int seed[])
 Sets the initial seed of this class to the 32 integers of array seed[0..31]. More...
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from RandomStreamBase
String name = null
 
boolean prec53 = false
 
boolean anti = false
 
- Static Protected Attributes inherited from RandomStreamBase
static double invtwo24 = 5.9604644775390625e-8
 

Detailed Description

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 [198], [199] , and which has a state size of 1024 bits and a period length of \(\rho\approx\) \(2^{1024}\). The values of \(V\), \(W\) and \(Z\) are \(2^{300}\), \(2^{400}\) and \(2^{700}\) 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. The output of nextValue has 32 bits of precision.

Constructor & Destructor Documentation

◆ WELL1024()

WELL1024 ( String  name)

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

Parameters
namename of the stream

Member Function Documentation

◆ clone()

WELL1024 clone ( )

Clones the current generator and return its copy.

Returns
A deep copy of the current generator

Implements CloneableRandomStream.

◆ getState()

int [] getState ( )

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

Returns
the current state of the stream

◆ setPackageSeed()

static void setPackageSeed ( int  seed[])
static

Sets the initial seed of this class to the 32 integers of array seed[0..31].

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

Parameters
seedarray of 32 elements representing the seed

◆ setSeed()

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..31]. 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
seedarray of 32 elements representing the seed

◆ toString()

String toString ( )

Returns a string containing the current state of this stream.

Returns
the state of the generator formated as a string

Implements RandomStream.


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