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

This class implements a umontreal.ssj.hups.PointSetRandomization that performs a left matrix scrambling. More...

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

Public Member Functions

 LMScramble ()
 Empty constructor.
 LMScramble (RandomStream stream)
 Sets internal variable stream to the given stream.
void randomize (PointSet p)
 This method calls only umontreal.ssj.hups.DigitalNet.leftMatrixScramble(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.

The point set must be a umontreal.ssj.hups.DigitalNet.

Definition at line 37 of file LMScramble.java.

Constructor & Destructor Documentation

◆ LMScramble() [1/2]

umontreal.ssj.hups.LMScramble.LMScramble ( )

Empty constructor.

Definition at line 42 of file LMScramble.java.

◆ LMScramble() [2/2]

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

Sets internal variable stream to the given stream.

Parameters
streamstream to use in the randomization

Definition at line 50 of file LMScramble.java.

Member Function Documentation

◆ randomize()

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

This method calls only umontreal.ssj.hups.DigitalNet.leftMatrixScramble(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 61 of file LMScramble.java.

◆ toString()

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

Returns a descriptor of this object.

Reimplemented from umontreal.ssj.hups.RandomShift.

Definition at line 72 of file LMScramble.java.


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