SSJ API Documentation
Stochastic Simulation in Java
Loading...
Searching...
No Matches
umontreal.ssj.hups.BakerTransformedPointSet Class Reference

This container class embodies a point set to which a baker's transformation (also called a tent transform) is applied (see, e.g., [47], [81], [152]). More...

Inheritance diagram for umontreal.ssj.hups.BakerTransformedPointSet:
umontreal.ssj.hups.ContainerPointSet umontreal.ssj.hups.PointSet

Classes

class  BakerTransformedPointSetIterator

Public Member Functions

 BakerTransformedPointSet (PointSet p)
 Constructs a baker-transformed point set from the given point set p.
double getCoordinate (int i, int j)
 By default, returns the untransformed coordinate \(u_{i,j}\) for the contained point set.
PointSetIterator iterator ()
 Return an iterator for this ContainerPointSet.
String toString ()
 Formats a string that contains information about the point set.
Public Member Functions inherited from umontreal.ssj.hups.ContainerPointSet
PointSet getOriginalPointSet ()
 Returns the (untransformed) point set contained in this container.
int getDimension ()
 Returns the dimension of the contained point set.
int getNumPoints ()
 Returns the number of points in the contained point set.
void randomize (PointSetRandomization rand)
 Randomizes the contained point set using rand.
void addRandomShift (int d1, int d2, RandomStream stream)
 Calls addRandomShift(d1, d2, stream) of the contained point set.
void addRandomShift (RandomStream stream)
 Calls addRandomShift(stream) of the contained point set.
void clearRandomShift ()
 Calls clearRandomShift() of the contained point set.
Public Member Functions inherited from umontreal.ssj.hups.PointSet
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.
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.
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.
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.
String formatPoints (PointSetIterator iter, int n, int d)
 Same as invoking formatPoints(n, d), but prints the points by calling iter repeatedly.
String formatPointsBase (int b)
 Similar to formatPoints(), but the points coordinates are printed in base \(b\).
String formatPointsBase (int n, int d, int b)
 Similar to formatPoints(n, d), but the points coordinates are printed in base \(b\).
String formatPointsBase (PointSetIterator iter, int b)
 Similar to formatPoints(iter), but the points coordinates are printed in base.
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\).
String formatPointsNumbered ()
 Same as invoking formatPointsNumbered(n, d) with \(n\) and \(d\) equal to the number of points and the dimension, respectively.
String formatPointsNumbered (int n, int d)
 Same as invoking formatPoints(n,d), except that the points are numbered.

Additional Inherited Members

Static Public Member Functions inherited from umontreal.ssj.hups.PointSet
static int getMaxBits ()
 Returns the maximum number of usable bits.
Protected Member Functions inherited from umontreal.ssj.hups.ContainerPointSet
void init (PointSet p0)
 Initializes this container point set so that it will contain the point set p0.
Protected Attributes inherited from umontreal.ssj.hups.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.
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.
RandomStream shiftStream
 Stream used to generate the random shifts.
Static Protected Attributes inherited from umontreal.ssj.hups.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.

Detailed Description

This container class embodies a point set to which a baker's transformation (also called a tent transform) is applied (see, e.g., [47], [81], [152]).

It transforms each coordinate \(u\) of each point into \(2u\) if \(u \le1/2\) and

\(2(1-u)\) if \(u > 1/2\).

         <div class="SSJ-bigskip"></div><div class="SSJ-bigskip"></div>

Definition at line 39 of file BakerTransformedPointSet.java.

Constructor & Destructor Documentation

◆ BakerTransformedPointSet()

umontreal.ssj.hups.BakerTransformedPointSet.BakerTransformedPointSet ( PointSet p)

Constructs a baker-transformed point set from the given point set p.

Parameters
ppoint set for which we want a baker-transformed version

Definition at line 46 of file BakerTransformedPointSet.java.

Member Function Documentation

◆ getCoordinate()

double umontreal.ssj.hups.BakerTransformedPointSet.getCoordinate ( int i,
int j )

By default, returns the untransformed coordinate \(u_{i,j}\) for the contained point set.

Returns
\(u_{i,j}\) for the contained point set

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 50 of file BakerTransformedPointSet.java.

◆ iterator()

PointSetIterator umontreal.ssj.hups.BakerTransformedPointSet.iterator ( )

Return an iterator for this ContainerPointSet.

Returns
a new ContainerPointSetIterator

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 58 of file BakerTransformedPointSet.java.

◆ toString()

String umontreal.ssj.hups.BakerTransformedPointSet.toString ( )

Formats a string that contains information about the point set.

Returns
string representation of the point set information

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 62 of file BakerTransformedPointSet.java.


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