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

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

Inheritance diagram for umontreal.ssj.hups.RandomStart:
umontreal.ssj.hups.PointSetRandomization

Public Member Functions

 RandomStart ()
 Empty constructor.
 RandomStart (RandomStream stream)
 Sets internal variable stream to the given stream.
void randomize (PointSet p)
 This method calls umontreal.ssj.hups.HaltonSequence.init(double[]).
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 randomizes a sequence simply by taking a random starting point.

For now, this only applies to the Halton sequence, but it could eventually be generalized to other types of sequences. The point set must be an instance of umontreal.ssj.hups.HaltonSequence or an IllegalArgumentException is thrown.

Definition at line 39 of file RandomStart.java.

Constructor & Destructor Documentation

◆ RandomStart() [1/2]

umontreal.ssj.hups.RandomStart.RandomStart ( )

Empty constructor.

Definition at line 46 of file RandomStart.java.

◆ RandomStart() [2/2]

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

Sets internal variable stream to the given stream.

Parameters
streamstream to use in the randomization

Definition at line 54 of file RandomStart.java.

Member Function Documentation

◆ getStream()

RandomStream umontreal.ssj.hups.RandomStart.getStream ( )

Returns the internal umontreal.ssj.rng.RandomStream.

Returns
stream used in the randomization

Implements umontreal.ssj.hups.PointSetRandomization.

Definition at line 89 of file RandomStart.java.

◆ randomize()

void umontreal.ssj.hups.RandomStart.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 umontreal.ssj.hups.PointSetRandomization.

Definition at line 65 of file RandomStart.java.

◆ setStream()

void umontreal.ssj.hups.RandomStart.setStream ( RandomStream stream)

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

Parameters
streamstream to use in the randomization

Implements umontreal.ssj.hups.PointSetRandomization.

Definition at line 80 of file RandomStart.java.


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