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...
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 () |
| Erases all the random permutations of the padded point sets that are randomly permuted. More... | |
| void | randomize (RandomStream stream) |
Randomly permutes the points for the padded point sets that have been added via padPointSetPermute. | |
| PointSetIterator | iterator () |
Returns a PaddedIterator for this padded point set. | |
| String | toString () |
 Public Member Functions inherited from PointSet | |
| int | getDimension () |
| Returns the dimension (number of available coordinates) of the points. 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 | randomize (PointSetRandomization rand) |
Randomizes this point set using the given rand. More... | |
| void | addRandomShift (int d1, int d2, RandomStream stream) |
By default, this method generates a random shift in the protected double[] array shift, to be used eventually for a random shift modulo 1. More... | |
| void | addRandomShift (RandomStream stream) |
Same as addRandomShift(0, dim, stream), where dim is the dimension of the point set. More... | |
| void | addRandomShift (int d1, int d2) |
Refreshes the random shift (generates new uniform values for the random shift coordinates) for coordinates d1 to d2-1, using the saved shiftStream. | |
| void | addRandomShift () |
Same as addRandomShift(0, dim), where dim is the dimension of the point set. | |
| void | clearRandomShift () |
| Erases the current random shift, if any. | |
| 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] |
| To avoid 0 for nextCoordinate when random shifting, we add this to each coordinate. | |
| int | dim = 0 |
| Dimension of the points. | |
| int | numPoints = 0 |
| Number of points. | |
| int | dimShift = 0 |
| Current dimension of the shift. More... | |
| int | capacityShift = 0 |
| Number of array elements in the shift vector, always >= dimShift. | |
| double [] | shift |
This is the shift vector as a double[] array, which contains the current random shift in case we apply a random shift modulo 1. More... | |
| RandomStream | shiftStream |
| Stream used to generate the random shifts. More... | |
Additional Inherited Members | |
| Static Protected Attributes inherited from PointSet | |
| static final int | MAXBITS = 31 |
| Since Java has no unsigned type, the 32nd bit cannot be used efficiently, so we have only 31 bits. More... | |
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 as proposed in [194], 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 then generated for all point sets that have been padded by padPointSetPermute. This is all what this randomize method does. If other randomizations are desired, the must be applied separately.
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, via the method padPointSet.
- Parameters
-
maxPointSets maximum number of point sets authorized by the constructed object.
Member Function Documentation
◆ getCoordinate()
| double getCoordinate | ( | int | i, |
| int | j | ||
| ) |
- Returns
- Coordinate \(u_{i,j}\) for the padded point set.
◆ padPointSet()
| void padPointSet | ( | PointSet | P | ) |
Pads the point set P to the present structure.
This adds new coordinates to the points.
- Parameters
-
P point set being padded
◆ padPointSetPermute()
| void padPointSetPermute | ( | PointSet | P | ) |
Pads the point set P, which is assumed to be finite.
A new random permutation of these points will be generated when calling randomize and will be used to access the coordinates taken from the points of P (i.e., these points are randomly permuted).
- Parameters
-
P point set being padded
◆ unrandomize()
| void unrandomize | ( | ) |
Erases all the random permutations of the padded point sets that are randomly permuted.
All the permutations are reset to the identity.
The documentation for this class was generated from the following file:
- PaddedPointSet.java
