SSJ  3.2.1
Stochastic Simulation in Java
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CycleBasedPointSet Class Referenceabstract

This abstract class provides the basic structures for storing and manipulating a highly uniform point set defined by a set of cycles. More...

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

Classes

class  CycleBasedPointSetIterator
 

Public Member Functions

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...
 

Protected Member Functions

void addCycle (AbstractList c)
 Adds the cycle c to the list of all cycles. More...
 

Protected Attributes

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
 

Additional Inherited Members

- Static Protected Attributes inherited from PointSet
static final int MAXBITS = 31
 

Detailed Description

This abstract class provides the basic structures for storing and manipulating a highly uniform point set defined by a set of cycles.

The \(s\)-dimensional points are all the vectors of \(s\) successive values found in any of the cycles, from any starting point. Since this is defined for any positive integer \(s\), the points effectively have an infinite number of dimensions. The number of points, \(n\), is the sum of lengths of all the cycles. The cycles of the point set are simply stored as a list of arrays, where each array contains the successive values for a given cycle. By default, the values are stored in double.

This structure is convenient for implementing recurrence-based point sets, where the point set in \(s\) dimensions is defined as the set of all vectors of \(s\) successive values of a periodic recurrence, from all its possible initial states.

Member Function Documentation

◆ addCycle()

void addCycle ( AbstractList  c)
protected

Adds the cycle c to the list of all cycles.

This method is used by subclass constructors to fill up the list of cycles.

◆ addRandomShift()

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.

This applies an addition modulo 1 of a single random point to all the points.

Parameters
streamStream used to generate random numbers

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