SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.hups.LMScrambleShift Class Reference

This class implements a umontreal.ssj.hups.PointSetRandomization that performs a left matrix scrambling and adds a random digital shift. More...

Inheritance diagram for umontreal.ssj.hups.LMScrambleShift:
umontreal.ssj.hups.RandomShift umontreal.ssj.hups.PointSetRandomization

Public Member Functions

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

Detailed Description

This class implements a umontreal.ssj.hups.PointSetRandomization that performs a left matrix scrambling and adds a random digital shift.

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

Definition at line 38 of file LMScrambleShift.java.

Constructor & Destructor Documentation

◆ LMScrambleShift() [1/2]

umontreal.ssj.hups.LMScrambleShift.LMScrambleShift ( )

Empty constructor.

Definition at line 43 of file LMScrambleShift.java.

◆ LMScrambleShift() [2/2]

umontreal.ssj.hups.LMScrambleShift.LMScrambleShift ( RandomStream stream)

Sets internal variable stream to the given stream.

Parameters
streamstream to use in the randomization

Definition at line 51 of file LMScrambleShift.java.

Member Function Documentation

◆ randomize()

void umontreal.ssj.hups.LMScrambleShift.randomize ( PointSet p)

This method calls umontreal.ssj.hups.DigitalNet.leftMatrixScramble(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

Reimplemented from umontreal.ssj.hups.RandomShift.

Definition at line 63 of file LMScrambleShift.java.

◆ toString()

String umontreal.ssj.hups.LMScrambleShift.toString ( )

Returns a descriptor of this object.

Reimplemented from umontreal.ssj.hups.RandomShift.

Definition at line 75 of file LMScrambleShift.java.


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