This class implements a PointSetRandomization that performs Owen's nested uniform scrambling [191], [195] . More...

Inheritance diagram for NestedUniformScrambling:

Collaboration diagram for NestedUniformScrambling:

Public Member Functions
	NestedUniformScrambling ()
	Empty constructor.

	NestedUniformScrambling (RandomStream stream)
	Create a `NestedUniformScrambling` instance, using `stream` as the random generator, and randomizing all of the DigitalNet.outDigits output bits of the DigitalNetBase2, up to 31 bits. More...

	NestedUniformScrambling (RandomStream stream, int numBits)
	Create a `NestedUniformScrambling` instance, using `stream` as the random generator, and randomizing only the first `numBits` output bits of the `DigitalNetBase2`. More...

RandomStream	getStream ()
	Returns the internal umontreal.ssj.rng.RandomStream. More...

void	setStream (RandomStream stream)
	Sets the internal umontreal.ssj.rng.RandomStream to `stream`. More...

void	setNumBits (int numBits)
	Set the number of bits to randomize to `numBits`

void	randomize (PointSet p)
	This method calls scrambles the points in the cached point set. More...

String	toString ()
	Returns a descriptor of this object.

Detailed Description

This class implements a PointSetRandomization that performs Owen's nested uniform scrambling [191], [195] .

The point set must be a CachedPointSet of a DigitalNetBase2.

To use this randomization, one should should call the randomize() function of an instance of NestedUniformScrambling with, as its argument, an instance of CachedPointSet with a reference to a DigitalNetBase2 instance. The actual implementation is done in DigitalNetBase2.nestedUniformScramble().

Warning: Calling CachedPointSet.randomize() with an instance of NestedUniformScrambling as its arguments will not work, because CachedPointSet.randomize() calls randomize() on its reference point set. However, this randomization modifies the cached values and not the original point set.

Constructor & Destructor Documentation

◆ NestedUniformScrambling() [1/2]

NestedUniformScrambling ( RandomStream stream )

Create a NestedUniformScrambling instance, using stream as the random generator, and randomizing all of the DigitalNet.outDigits output bits of the DigitalNetBase2, up to 31 bits.

Parameters

stream stream to use in the randomization

◆ NestedUniformScrambling() [2/2]

NestedUniformScrambling	(	RandomStream	stream,
		int	numBits
	)

Create a NestedUniformScrambling instance, using stream as the random generator, and randomizing only the first numBits output bits of the DigitalNetBase2.

Parameters

stream	stream to use in the randomization
numBits	number of output bits to scramble (it can be smaller than, equal to or larger than the number of output bits in the DigitalNetBase2).