SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | List of all members
HammersleyPointSet Class Reference

This class implements Hammersley point sets, which are defined as follows. More...

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

Public Member Functions

 HammersleyPointSet (int n, int dim)
 Constructs a new Hammersley point set with n points in dim dimensions. More...
 
void addFaurePermutations ()
 Permutes the digits using Faure permutations for all coordinates. More...
 
void ErasePermutations ()
 Erases the Faure permutations: from now on, the digits will not be Faure permuted.
 
double getCoordinate (int i, int j)
 
- 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...
 

Additional Inherited Members

- 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...
 
- 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 class implements Hammersley point sets, which are defined as follows.

Let \(2 = b_1 < b_2 < \cdots\) denote the sequence of all prime numbers by increasing order. The Hammersley point set with \(n\) points in \(s\) dimensions contains the points

\[ \mathbf{u}_i = (i/n,\psi_{b_1}(i),\psi_{b_2}(i),…, \psi_{b_{s-1}}(i)), \tag{Hammersley-point2} \]

for \(i=0,…,n-1\), where \(\psi_b\) is the radical inverse function in base \(b\), defined in RadicalInverse. This class is not a subclass of DigitalNet, because the basis is not the same for all coordinates. We do obtain a net in a generalized sense if \(n = b_1^{k_1} = b_2^{k_2} = \cdots= b_{s-1}^{k_{s-1}}\) for some integers \(k_1,…,k_{s-1}\).

The points of a Hammersley point set can be "scrambled" by applying a permutation to the digits of \(i\) before computing each coordinate via ( Hammersley-point ). If

\[ i = a_0 + a_1 b_j + …+ a_{k_j-1} b_j^{k_j-1}, \]

and \(\pi_j\) is a permutation of the digits \(\{0,…,b_j-1\}\), then

\[ \psi_{b_j}(i) = \sum_{r=0}^{k_j-1} a_r b_j^{-r-1} \]

is replaced in ( Hammersley-point ) by

\[ u_{i,j}= \sum_{r=0}^{k_j-1} \pi_j[a_r] b_j^{-r-1}. \]

The permutations \(\pi_j\) can be deterministic or random. One (deterministic) possibility implemented here is to use the Faure permutation of \(\{0,…,b_j\}\) for \(\pi_j\), for each coordinate \(j > 0\).

Constructor & Destructor Documentation

◆ HammersleyPointSet()

HammersleyPointSet ( int  n,
int  dim 
)

Constructs a new Hammersley point set with n points in dim dimensions.

Parameters
nnumber of points
dimdimension of the point set

Member Function Documentation

◆ addFaurePermutations()

void addFaurePermutations ( )

Permutes the digits using Faure permutations for all coordinates.

After the method is called, the coordinates \(u_{i,j}\) are generated via

\[ u_{i,j} = \sum_{r=0}^{k-1} \pi_j[a_r] b_j^{-r-1}, \]

for \(j=1,…,s-1\) and \(u_{i,0}=i/n\), where \(\pi_j\) is the Faure permutation of \(\{0,…,b_j-1\}\).


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