SSJ
V. labo.

umontreal.iro.lecuyer.hups
Class PaddedPointSet

java.lang.Object
  extended by umontreal.iro.lecuyer.hups.PointSet
      extended by umontreal.iro.lecuyer.hups.PaddedPointSet

public class PaddedPointSet
extends PointSet

This container class realizes padded point sets, constructed by taking some coordinates from a point set P1, other coordinates from a point set P2, and so on. This can be used to implement latin supercube sampling, 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 Summary
PaddedPointSet(int maxPointSets)
          Constructs a structure for padding at most maxPointSets point sets.
 
Method Summary
 double getCoordinate(int i, int j)
          .
 PointSetIterator iterator()
          .
 void padPointSet(PointSet P)
          Pads the point set P to the present structure.
 void padPointSetPermute(PointSet P)
          Pads the point set P, which is assumed to be finite.
 void randomize(RandomStream stream)
          .
 String toString()
          .
 void unrandomize()
          .
 
Methods inherited from class umontreal.iro.lecuyer.hups.PointSet
addRandomShift, addRandomShift, addRandomShift, addRandomShift, clearRandomShift, formatPoints, formatPoints, formatPoints, formatPoints, formatPointsBase, formatPointsBase, formatPointsBase, formatPointsBase, formatPointsNumbered, formatPointsNumbered, getDimension, getNumPoints, getStream, randomize, randomize, randomize, randomize, setStream
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PaddedPointSet

public 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:
maxPointSets - maximum number of point sets authorized by the constructed object
Method Detail

padPointSet

public void padPointSet(PointSet P)
Pads the point set P to the present structure.

Parameters:
P - point set being padded

padPointSetPermute

public 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:
P - point set being padded

getCoordinate

public double getCoordinate(int i,
                            int j)
Description copied from class: PointSet
. \begin{tabb}
 Returns $u_{i,j}$, the coordinate $j$\ of the point $i$.
 \richard{...
 ...xttt{getCoordinate} impl\'ementent le random shift
 quand il existe?}
 \end{tabb}
iindex of the point to look for jindex of the coordinate to look for the value of ui, j

Specified by:
getCoordinate in class PointSet

unrandomize

public void unrandomize()
Description copied from class: PointSet
. \begin{tabb}By default, this method simply calls
 \texttt{clearRandomShift()}.
 \end{tabb}

Overrides:
unrandomize in class PointSet

randomize

public void randomize(RandomStream stream)
Description copied from class: PointSet
. \begin{tabb}By default, this method simply calls
 \method{randomize (0, dim, stream)}.
 \end{tabb}

 

Overrides:
randomize in class PointSet

iterator

public PointSetIterator iterator()
Description copied from class: PointSet
. \begin{tabb}
 Constructs and returns a point set iterator.
 The default implemen...
 ...oordinates, but subclasses can reimplement it
 for better efficiency.
 \end{tabb}
point set iterator for the point set

Overrides:
iterator in class PointSet

toString

public String toString()
Description copied from class: PointSet
. \begin{tabb}
 Formats a string that contains information about the point set.
 \end{tabb}
string representation of the point set information

Overrides:
toString in class PointSet

SSJ
V. labo.

To submit a bug or ask questions, send an e-mail to Pierre L'Ecuyer.