SSJ  3.2.1
Stochastic Simulation in Java
Public Member Functions | List of all members
PointSetRandomization Interface Reference

This interface is used to randomize a umontreal.ssj.hups.PointSet. More...

Inheritance diagram for PointSetRandomization:
[legend]

Public Member Functions

void randomize (PointSet p)
 This method must randomize p. 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...
 

Detailed Description

This interface is used to randomize a umontreal.ssj.hups.PointSet.

One can implement method randomize(PointSet) in any way. This method must use an internal umontreal.ssj.rng.RandomStream. This stream can be set in the constructor, but the methods getStream and setStream(RandomStream) must be implemented.

The method randomize(PointSet) must be implemented using combinations of the randomization methods from the point set such as umontreal.ssj.hups.PointSet.addRandomShift, umontreal.ssj.hups.DigitalNet.leftMatrixScramble, umontreal.ssj.hups.DigitalNet.stripedMatrixScramble, …

If more than one PointSetRandomization is applied to the same point set, the randomizations will concatenate if they are of different types, but only the last of each type will remain.

Remarks
Pierre: There should be examples to illustrate how this works and how to use it.

Member Function Documentation

◆ getStream()

RandomStream getStream ( )

Returns the internal umontreal.ssj.rng.RandomStream.

Returns
stream used in the randomization

Implemented in RandomStart, RandomShift, NestedUniformScrambling, and EmptyRandomization.

◆ randomize()

void randomize ( PointSet  p)

This method must randomize p.

Parameters
pPoint set to randomize

Implemented in NestedUniformScrambling, RandomShift, RandomStart, LMScrambleShift, SMScrambleShift, and EmptyRandomization.

◆ setStream()

void setStream ( RandomStream  stream)

Sets the internal umontreal.ssj.rng.RandomStream to stream.

Parameters
streamstream to use in the randomization

Implemented in NestedUniformScrambling, RandomStart, RandomShift, and EmptyRandomization.


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