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

This container class realizes padded point sets, constructed by taking some coordinates from a point set \(P_1\), other coordinates from a point set \(P_2\), and so on. More...

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

Public Member Functions

 PaddedPointSet (int maxPointSets)
 Constructs a structure for padding at most maxPointSets point sets. More...
 
void padPointSet (PointSet P)
 Pads the point set P to the present structure. More...
 
void padPointSetPermute (PointSet P)
 Pads the point set P, which is assumed to be finite. More...
 
double getCoordinate (int i, int j)
 
void unrandomize ()
 
void randomize (RandomStream stream)
 
PointSetIterator iterator ()
 
String toString ()
 
- 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 Attributes

int curPointSets = 0
 
int maxPointSets
 
PointSet pointSet []
 
int startDim []
 
int permutation [][]
 
- 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 container class realizes padded point sets, constructed by taking some coordinates from a point set \(P_1\), other coordinates from a point set \(P_2\), and so on.

This can be used to implement latin supercube sampling [183] , for example. After calling the constructor to create the structure, component point sets can be padded to it by calling padPointSet or padPointSetPermute.

Only sets with the same number of points can be padded. Point sets with too many points or coordinates can be trimmed down by using the class SubsetOfPointSet before they are padded. Infinite-dimensional point sets are allowed, but once one is padded, no additional point set can be padded.

The points of each padded set can be permuted randomly, independently across the padded sets. If such a random permutation is desired, the point set should be padded via padPointSetPermute. When calling #randomize, random permutations are generated for all point sets that have been padded by padPointSetPermute.

Constructor & Destructor Documentation

◆ PaddedPointSet()

PaddedPointSet ( int  maxPointSets)

Constructs a structure for padding at most maxPointSets point sets.

This structure is initially empty and will eventually contain the different point sets that are padded.

Parameters
maxPointSetsmaximum number of point sets authorized by the constructed object

Member Function Documentation

◆ padPointSet()

void padPointSet ( PointSet  P)

Pads the point set P to the present structure.

Parameters
Ppoint set being padded

◆ padPointSetPermute()

void padPointSetPermute ( PointSet  P)

Pads the point set P, which is assumed to be finite.

A random permutation will be generated (when calling #randomize ) and used to access the coordinates taken from the points of P (i.e., these points are randomly permuted).

Parameters
Ppoint set being padded

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