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

Implements a random stream that mixes two input streams by using a coordinate mask. More...

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

Public Member Functions

 SplitStream (RandomStream stream, int nCache)
 Reads 2 * nCache values from a a stream and stores them for future use. More...
 
 SplitStream (double[] vals)
 
SplitStream clone ()
 Clones the current object and returns its copy. More...
 
void setCoordinates (CoordinateSet coords)
 
CoordinateSet getCoordinates ()
 
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\).
 
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\).
 
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...
 

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

Protected Attributes

int curCoordIndex
 
CoordinateSet coords
 
double [] vals
 
- Protected Attributes inherited from RandomStreamBase
String name = null
 
boolean prec53 = false
 
boolean anti = false
 

Additional Inherited Members

- Static Protected Attributes inherited from RandomStreamBase
static double invtwo24 = 5.9604644775390625e-8
 

Detailed Description

Implements a random stream that mixes two input streams by using a coordinate mask.

Constructor & Destructor Documentation

◆ SplitStream()

SplitStream ( RandomStream  stream,
int  nCache 
)

Reads 2 * nCache values from a a stream and stores them for future use.

When nextValue() is called, a value is popped from the 2 * nCache cached values at even indices for the coordinates contained in the coordinate set coords, and at odd indices otherwise.

Member Function Documentation

◆ clone()

SplitStream clone ( )

Clones the current object and returns its copy.

Returns
A deep copy of the current object

Implements CloneableRandomStream.

◆ 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: