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

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

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

Public Member Functions

 GenF2w32 ()
 Constructs a new stream.
 
 GenF2w32 (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 25 integers. More...
 
GenF2w32 clone ()
 Clones the current generator and return its copy. 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...
 
- 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 the class GenF2w2r32 to the 25 integers of the vector seed[0..24]. More...
 
static void main (String[] args)
 This method is only meant to be used during the compilation process. 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...
 

Static Package Functions

 [static initializer]
 

Static Package Attributes

static final int W2 = 11
 
static final int W3 = 10
 
static int [] BrmT2
 
static int [] BrmT3
 
static int [] Br2
 
static int [] Br3
 

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 Linear Congruential Generator (LCG) in the finite field \(\mathbb F_{2^w}\) instead of \(\mathbb F_2\). The implemented generator is the GenF2w2_32 proposed by Panneton [196], [199] . Its state is 25 32-bit words and it has a period length of \(2^{800} - 1\). The values of \(V\), \(W\) and \(Z\) are \(2^{200}\), \(2^{300}\) and \(2^{500}\) respectively (see RandomStream for their definition). The seed of the RNG, and the state of a stream at any given step, is a 25-dimensional vector of 32-bits integers. Its nextValue method returns numbers with 32 bits of precision.

Constructor & Destructor Documentation

◆ GenF2w32()

GenF2w32 ( String  name)

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

Parameters
namename of the stream

Member Function Documentation

◆ clone()

GenF2w32 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 25 integers.

Returns
the current state of the stream

◆ main()

static void main ( String []  args)
static

This method is only meant to be used during the compilation process.

It is used to create the resource file the class need in order to run.

◆ setPackageSeed()

static void setPackageSeed ( int  seed[])
static

Sets the initial seed of the class GenF2w2r32 to the 25 integers of the vector seed[0..24].

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

Parameters
seedarray of 25 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..24]. 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 25 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: