SSJ  3.2.1
Stochastic Simulation in Java
Public Member Functions | Protected Attributes | List of all members
RandomStart Class Reference

This class implements a umontreal.ssj.hups.PointSetRandomization that randomizes a sequence with a random starting point. More...

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

Public Member Functions

 RandomStart ()
 Empty constructor.
 
 RandomStart (RandomStream stream)
 Sets internal variable stream to the given stream. More...
 
void randomize (PointSet p)
 This method calls umontreal.ssj.hups.HaltonSequence.init(double[]). 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...
 

Protected Attributes

RandomStream stream
 

Detailed Description

This class implements a umontreal.ssj.hups.PointSetRandomization that randomizes a sequence with a random starting point.

The point set must be an instance of umontreal.ssj.hups.HaltonSequence or an IllegalArgumentException is thrown. For now, only the Halton sequence is allowed, but there may be others later.

Constructor & Destructor Documentation

◆ RandomStart()

Sets internal variable stream to the given stream.

Parameters
streamstream to use in the randomization

Member Function Documentation

◆ getStream()

RandomStream getStream ( )

Returns the internal umontreal.ssj.rng.RandomStream.

Returns
stream used in the randomization

Implements PointSetRandomization.

◆ randomize()

void randomize ( PointSet  p)

This method calls umontreal.ssj.hups.HaltonSequence.init(double[]).

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

Parameters
pPoint set to randomize

Implements PointSetRandomization.

◆ setStream()

void setStream ( RandomStream  stream)

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

Parameters
streamstream to use in the randomization

Implements PointSetRandomization.


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