Similar to CycleBasedPointSet, except that the successive values in the cycles are stored as integers in the range \(\{0,\dots,2^k-1\}\), where. More...

Inheritance diagram for umontreal.ssj.hups.CycleBasedPointSetBase2:

Classes
class	CycleBasedPointSetBase2Iterator

Public Member Functions
double	getCoordinate (int i, int j)
	Returns \(u_{i,j}\), the coordinate \(j\) of the point \(i\).
PointSetIterator	iterator ()
	Constructs and returns a point set iterator.
void	addRandomShift (int d1, int d2, RandomStream stream)
	Adds a random digital shift in base 2 to all the points of the point set, using stream stream to generate the random numbers, for coordinates d1 to d2 - 1.
void	clearRandomShift ()
	Erases the current digital random shift, if any.
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.
Public Member Functions inherited from umontreal.ssj.hups.CycleBasedPointSet
int	getDimension ()
	Returns the dimension (number of available coordinates) of the points.
String	toString ()
	Formats a string that contains information about the point set.
Public Member Functions inherited from umontreal.ssj.hups.PointSet
int	getNumPoints ()
	Returns the number of points.
void	randomize (PointSetRandomization rand)
	Randomizes this point set using the given rand.
void	addRandomShift (RandomStream stream)
	Same as `addRandomShift(0, dim, stream)`, where dim is the dimension of the point set.
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 (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.CycleBasedPointSet
void	addCycle (AbstractList c)
	Adds the cycle c to the list of all cycles.
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

Similar to CycleBasedPointSet, except that the successive values in the cycles are stored as integers in the range \(\{0,\dots,2^k-1\}\), where.

\(1\le k \le31\). The output values \(u_{i,j}\) are obtained by dividing these integer values by \(2^k\). Point sets where the successive coordinates of each point are obtained via linear recurrences modulo 2 (e.g., linear feedback shift registers or Korobov-type polynomial lattice rules) are naturally expressed in this form. Storing the integers \(2^k u_{i,j}\) instead of the \(u_{i,j}\) themselves makes it easier to apply randomizations such as digital random shifts in base 2, which are applied to the bits before transforming the value to a real number \(u_{i,j}\). When a random digital shift is performed, it applies a bitwise exclusive-or of all the points with a single random point.

Definition at line 50 of file CycleBasedPointSetBase2.java.

Member Function Documentation

◆ addRandomShift()

void umontreal.ssj.hups.CycleBasedPointSetBase2.addRandomShift	(	int	d1,
		int	d2,
		RandomStream	stream )

Adds a random digital shift in base 2 to all the points of the point set, using stream stream to generate the random numbers, for coordinates d1 to d2 - 1.

This applies a bitwise exclusive-or of all the points with a single random point.

Reimplemented from umontreal.ssj.hups.CycleBasedPointSet.

Definition at line 86 of file CycleBasedPointSetBase2.java.

◆ clearRandomShift()

void umontreal.ssj.hups.CycleBasedPointSetBase2.clearRandomShift ( )

Erases the current digital random shift, if any.

Reimplemented from umontreal.ssj.hups.CycleBasedPointSet.

Definition at line 120 of file CycleBasedPointSetBase2.java.

◆ formatPoints()

String umontreal.ssj.hups.CycleBasedPointSetBase2.formatPoints ( )

Same as invoking formatPoints(n, d) with \(n\) and \(d\) equal to the number of points and the dimension of this object, respectively.

Returns: string representation of all the points in the point set

Exceptions

UnsupportedOperationException if the number of points or dimension of the point set is infinite

Reimplemented from umontreal.ssj.hups.CycleBasedPointSet.

Definition at line 125 of file CycleBasedPointSetBase2.java.

◆ getCoordinate()

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

Returns \(u_{i,j}\), the coordinate \(j\) of the point \(i\).

When the points are randomized (e.g., a random shift is added), the values returned by this method should incorporate the randomizations. Richard: La méthode getCoordinate de certaines classes ne tient pas compte du random shift, contrairement à l’itérateur de la même classe. Faut-il que toutes les getCoordinate implémentent le random shift quand il existe? Oui.

Parameters

i	index of the point to look for
j	index of the coordinate to look for

Returns: the value of \(u_{i,j}\)

Reimplemented from umontreal.ssj.hups.CycleBasedPointSet.

Definition at line 58 of file CycleBasedPointSetBase2.java.

◆ iterator()

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

Constructs and returns a point set iterator.

The default implementation returns an iterator that uses the method getCoordinate(i,j) to iterate over the points and coordinates, but subclasses can reimplement it for better efficiency.

Returns: point set iterator for the point set

Reimplemented from umontreal.ssj.hups.CycleBasedPointSet.

Definition at line 76 of file CycleBasedPointSetBase2.java.

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

src/main/java/umontreal/ssj/hups/CycleBasedPointSetBase2.java

SSJ API Documentation Stochastic Simulation in Java

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addRandomShift()

◆ clearRandomShift()

◆ formatPoints()

◆ getCoordinate()

◆ iterator()