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

Implements a recurrence-based point set defined via a linear congruential recurrence of the form \(x_i = a x_{i-1} \mod n\) and \(u_i = x_i / n\). More...

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

Public Member Functions

 LCGPointSet (int n, int a)
 Constructs and stores the set of cycles for an LCG with modulus \(n\) and multiplier \(a\). More...
 
 LCGPointSet (int b, int e, int c, int a)
 Constructs and stores the set of cycles for an LCG with modulus \(n = b^e + c\) and multiplier \(a\).
 
String toString ()
 
int geta ()
 Returns the value of the multiplier \(a\).
 
- Public Member Functions inherited from CycleBasedPointSet
double getCoordinate (int i, int j)
 
void addRandomShift (int d1, int d2, RandomStream stream)
 Adds a random shift to all the points of the point set, using stream stream to generate the random numbers, for coordinates d1 to d2 - 1. More...
 
void clearRandomShift ()
 Erases the current random shift, if any.
 
int getDimension ()
 
PointSetIterator iterator ()
 
String toString ()
 
String formatPoints ()
 
- Public Member Functions inherited from PointSet
int getDimension ()
 Returns the dimension (number of available coordinates) of the point set. More...
 
int getNumPoints ()
 Returns the number of points. More...
 
abstract double getCoordinate (int i, int j)
 Returns \(u_{i,j}\), the coordinate \(j\) of the point \(i\). More...
 
PointSetIterator iterator ()
 Constructs and returns a point set iterator. More...
 
void setStream (RandomStream stream)
 Sets the random stream used to generate random shifts to stream. More...
 
RandomStream getStream ()
 Returns the random stream used to generate random shifts. More...
 
void randomize (PointSetRandomization rand)
 Randomizes the point set using the given rand. More...
 
void addRandomShift (int d1, int d2, RandomStream stream)
 This method does nothing for this generic class. More...
 
void addRandomShift (RandomStream stream)
 This method does nothing for this generic class. More...
 
void addRandomShift (int d1, int d2)
 Similar to addRandomShift(d1, d2, stream), with the current random stream.
 
void addRandomShift ()
 Similar to addRandomShift(0, d2, stream) with the current random stream and d2 the dimension of the current random shift.
 
void clearRandomShift ()
 Erases the current random shift, if any.
 
void randomize (int fromDim, int toDim, RandomStream stream)
 By default, this method simply calls addRandomShift (fromDim, toDim, stream), which does nothing.
 
void randomize (RandomStream stream)
 By default, this method simply calls randomize(0, dim, stream).
 
void randomize (int d1, int d2)
 By default, this method simply calls addRandomShift(d1, d2).
 
void randomize ()
 By default, this method simply calls addRandomShift().
 
void unrandomize ()
 By default, this method simply calls clearRandomShift().
 
String toString ()
 Formats a string that contains information about the point set. More...
 
String formatPoints ()
 Same as invoking formatPoints(n, d) with \(n\) and \(d\) equal to the number of points and the dimension of this object, respectively. More...
 
String formatPoints (int n, int d)
 Formats a string that displays the same information as returned by toString, together with the first \(d\) coordinates of the first \(n\) points. More...
 
String formatPoints (PointSetIterator iter)
 Same as invoking formatPoints(iter, n, d) with \(n\) and \(d\) equal to the number of points and the dimension, respectively. More...
 
String formatPoints (PointSetIterator iter, int n, int d)
 Same as invoking formatPoints(n, d), but prints the points by calling iter repeatedly. More...
 
String formatPointsBase (int b)
 Similar to formatPoints(), but the points coordinates are printed in base \(b\). More...
 
String formatPointsBase (int n, int d, int b)
 Similar to formatPoints(n, d), but the points coordinates are printed in base \(b\). More...
 
String formatPointsBase (PointSetIterator iter, int b)
 Similar to formatPoints(iter), but the points coordinates are printed in base \(b\). More...
 
String formatPointsBase (PointSetIterator iter, int n, int d, int b)
 Similar to formatPoints(iter, n, d), but the points coordinates are printed in base \(b\). More...
 
String formatPointsNumbered ()
 Same as invoking formatPointsNumbered(n, d) with \(n\) and \(d\) equal to the number of points and the dimension, respectively. More...
 
String formatPointsNumbered (int n, int d)
 Same as invoking formatPoints(n,d), except that the points are numbered. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CycleBasedPointSet
void addCycle (AbstractList c)
 Adds the cycle c to the list of all cycles. More...
 
- Protected Attributes inherited from CycleBasedPointSet
int numCycles = 0
 
ObjectArrayList cycles = new ObjectArrayList()
 
- Protected Attributes inherited from PointSet
double EpsilonHalf = 1.0 / Num.TWOEXP[55]
 
int dim = 0
 
int numPoints = 0
 
int dimShift = 0
 
int capacityShift = 0
 
RandomStream shiftStream
 
- Static Protected Attributes inherited from PointSet
static final int MAXBITS = 31
 

Detailed Description

Implements a recurrence-based point set defined via a linear congruential recurrence of the form \(x_i = a x_{i-1} \mod n\) and \(u_i = x_i / n\).

The implementation is done by storing the values of \(u_i\) over the set of all cycles of the recurrence.

Constructor & Destructor Documentation

◆ LCGPointSet()

LCGPointSet ( int  n,
int  a 
)

Constructs and stores the set of cycles for an LCG with modulus \(n\) and multiplier \(a\).

If the LCG has full period length \(n-1\), there are two cycles, the first one containing only 0 and the second one of period length \(n-1\).

Parameters
nrequired number of points and modulus of the LCG
agenerator \(a\) of the LCG

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