SSJ
3.2.1
Stochastic Simulation in Java
|
This class implements a stratification of the unit cube in rectangular boxes of same size and orientation. More...
Public Member Functions | |
StratifiedUnitCube (int[] k, int dim) | |
Builds a stratified points set in dim dimensions, with k[j] intervals in dimension j . More... | |
StratifiedUnitCube (int k, int dim) | |
Same as StratifiedUnitCube (int[] k, int dim) with all coordinates of the vector k equal to the integer k . More... | |
void | randomize (RandomStream stream) |
This randomization generates one point randomly in its corresponding box, for each of the \(n\) boxes. More... | |
void | addRandomShift (int fromDim, int toDim, RandomStream stream) |
Random shifts and partial randomizations are irrelevant here, so this method is redefined to be equivalent to randomize (stream) . More... | |
void | randomize (PointSetRandomization rand) |
Randomizes the points using stratification, regardless of what rand is. More... | |
String | toString () |
![]() | |
CachedPointSet (PointSet P, int fromPoint, int toPoint, int fromDim, int toDim) | |
Creates a new PointSet object that contains an array storing the coordinates fromDim (inclusive) to toDim (exclusive) of the points numbered fromPoint (inclusive) to toPoint (exclusive) of P . More... | |
CachedPointSet (PointSet P, int n, int dim) | |
Same as CachedPointSet(P, 0, n, 0, dim). | |
CachedPointSet (PointSet P) | |
Creates a new PointSet object that contains an array storing the points of P . More... | |
PointSetIterator | iterator () |
Constructs and returns a point set iterator which gets the values directly from the array. | |
void | setRandomizeParent (boolean randomizeParent) |
If randomizeParent is true , calls to randomize() will be defered to the parent point set (this is the default); otherwise, the randomize method of the PointSetRandomization instance is invoked with this CachedPointSet instance as its argument. | |
void | addRandomShift (int d1, int d2, RandomStream stream) |
Add the shift to the contained point set and re-caches the points. More... | |
void | randomize (PointSetRandomization rand) |
Randomizes the underlying point set using rand and re-caches the points. More... | |
void | sortByCoordinate (int j) |
Sorts the cached points by increasing order of coordinate j . More... | |
void | stripCoordinates (int d) |
Removes the first d coordinates of each cached point. More... | |
String | toString () |
double | getCoordinate (int i, int j) |
double [][] | getArray () |
PointSet | getParentPointSet () |
Returns the reference point set that was passed to the constructor. | |
![]() | |
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 [] | numDiv |
double [] | delta |
![]() | |
PointSet | P |
double | x [][] |
![]() | |
double | EpsilonHalf = 1.0 / Num.TWOEXP[55] |
int | dim = 0 |
int | numPoints = 0 |
int | dimShift = 0 |
int | capacityShift = 0 |
RandomStream | shiftStream |
Additional Inherited Members | |
![]() | |
void | fillCache (int fromDim, int dim) |
![]() | |
static final int | MAXBITS = 31 |
![]() | |
public< T > void | sort (MultiDimSort< T > sort) |
Sorts the cached points (only) with the given umontreal.ssj.util.MultiDimSort sorting algorithm sort . More... | |
![]() | |
int | fromPoint = 0 |
int | fromDim = 0 |
boolean | randomizeParent = true |
This class implements a stratification of the unit cube in rectangular boxes of same size and orientation.
In \(s\) dimensions, it divides the \(j\)th axis in \(k_j \ge1\) equal parts of length \(d_j = 1/k_j\), for \(j=0,…,s-1\). This partitions the unit cube \([0,1)^s\) into \(n = k_0\cdots k_{s-1}\) rectangular boxes of the same size. The point set is defined by generating one random point uniformly in each of those \(n\) boxes.
We number the boxes (or strata) as follows: The box determined by the interval \([c_j d_j, (c_j+1)d_j)\) for \(j=0,…,s-1\) has number \(i = c_0 + c_1 k_0 + \cdots+ c_{s-1} k_0 \cdots k_{s-2}\). By default, the points are enumerated by order of their box number. One can also create iterators that enumerate the points by order of any given coordinate.
Although this class extends CachedPointSet
, here there is no underlying point set P
that is cached.
StratifiedUnitCube | ( | int [] | k, |
int | dim | ||
) |
Builds a stratified points set in dim
dimensions, with k[j]
intervals in dimension j
.
k | number of intervals in each dimension |
dim | integer, dimension of the points set |
StratifiedUnitCube | ( | int | k, |
int | dim | ||
) |
Same as StratifiedUnitCube (int[] k, int dim)
with all coordinates of the vector k
equal to the integer k
.
This gives \(n = k^s\) strata (and points), with \(s = {\mathtt{dim}}\).
void addRandomShift | ( | int | fromDim, |
int | toDim, | ||
RandomStream | stream | ||
) |
Random shifts and partial randomizations are irrelevant here, so this method is redefined to be equivalent to randomize (stream)
.
The parameters fromDim
and toDim
are not used.
void randomize | ( | RandomStream | stream | ) |
This randomization generates one point randomly in its corresponding box, for each of the \(n\) boxes.
The stratified points are defined only after this method has been called.
stream | Random stream to generate the \(n\times{\mathtt{dim}}\) uniforms required to randomize the points |
void randomize | ( | PointSetRandomization | rand | ) |
Randomizes the points using stratification, regardless of what rand
is.
Equivalent to randomize (rand.getStream)
.