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

This class implements a umontreal.ssj.hups.PointSetRandomization that performs a striped matrix scrambling [195] and adds a random digital shift. More...

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

Public Member Functions

 SMScrambleShift ()
 Empty constructor.
 
 SMScrambleShift (RandomStream stream)
 Constructor that sets the internal variable stream to the given stream. More...
 
void randomize (PointSet p)
 This method calls umontreal.ssj.hups.DigitalNet.stripedMatrixScramble(RandomStream), then umontreal.ssj.hups.DigitalNet.addRandomShift(RandomStream). More...
 
String toString ()
 Returns a descriptor of this object.
 
- Public Member Functions inherited from RandomShift
 RandomShift ()
 Empty constructor: No stream is passed here for the randomization; one must be passed later by setStream. More...
 
 RandomShift (RandomStream stream)
 Constructor that sets the internal umontreal.ssj.rng.RandomStream to stream. More...
 
void randomize (PointSet p)
 This method calls addRandomShift(stream). More...
 
void setStream (RandomStream stream)
 Sets the internal umontreal.ssj.rng.RandomStream to stream. More...
 
RandomStream getStream ()
 Returns the internal umontreal.ssj.rng.RandomStream. More...
 
String toString ()
 Returns a descriptor of this object.
 

Additional Inherited Members

- Protected Attributes inherited from RandomShift
RandomStream stream
 

Detailed Description

This class implements a umontreal.ssj.hups.PointSetRandomization that performs a striped matrix scrambling [195] and adds a random digital shift.

Point set must be a umontreal.ssj.hups.DigitalNet or an IllegalArgumentException is thrown.

Constructor & Destructor Documentation

◆ SMScrambleShift()

Constructor that sets the internal variable stream to the given stream.

Parameters
streamstream to use in the randomization

Member Function Documentation

◆ randomize()

void randomize ( PointSet  p)

This method calls umontreal.ssj.hups.DigitalNet.stripedMatrixScramble(RandomStream), then umontreal.ssj.hups.DigitalNet.addRandomShift(RandomStream).

If p is not a umontreal.ssj.hups.DigitalNet, an IllegalArgumentException is thrown.

Parameters
pPoint set to randomize

Implements PointSetRandomization.


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