This container class embodies an arbitrary point set and its iterator adds a random shift modulo 1 to all the points, when producing the coordinates. More...

Inheritance diagram for umontreal.ssj.hups.RandShiftedMod1PointSet:

Public Member Functions
	RandShiftedMod1PointSet (PointSet p, int dimShift, RandomStream stream)
	Constructs a structure to contain a randomly shifted version of p.
int	getShiftDimension ()
	Returns the number of dimensions of the current random shift.
void	addRandomShift (int d1, int d2, RandomStream stream)
	Changes the stream used for the random shifts to stream, then refreshes the shift for coordinates d1 to d2-1.
void	addRandomShift (RandomStream stream)
	Changes the stream used for the random shifts to stream, then refreshes all coordinates of the random shift, up to its current dimension.
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.
void	addRandomShift ()
	Refreshes all coordinates of the random shift, up to its current dimension.
double	getCoordinate (int i, int j)
	Returns the shifted coordinate \(u_{i,j}\).
String	toString ()
	Formats a string that contains information about the point set.
PointSetIterator	iterator ()
	Returns a RandShiftedMod1PointSetIterator for this 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	clearRandomShift ()
	Calls clearRandomShift() of the contained point set.
Public Member Functions inherited from umontreal.ssj.hups.PointSet
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 an arbitrary point set and its iterator adds a random shift modulo 1 to all the points, when producing the coordinates.

The random shift modulo 1 is the same for all the points. This can be used for example to apply a random shift modulo 1 to a DigitalNet, for which a RandomShift would normally perform a random digital shift. Here, calling addRandomShift generates a new random shift, represented by a vector of \(d\) uniforms over \((0,1)\), where \(d\) is the current dimension of the shift. Then, an iterator for this point set will enumerate the points of the contained point set and apply this random shift modulo 1 to each of them.

Definition at line 46 of file RandShiftedMod1PointSet.java.

Constructor & Destructor Documentation

◆ RandShiftedMod1PointSet()

umontreal.ssj.hups.RandShiftedMod1PointSet.RandShiftedMod1PointSet	(	PointSet	p,
		int	dimShift,
		RandomStream	stream )

Constructs a structure to contain a randomly shifted version of p.

The random shifts will be generated in up to dimShift dimensions, using stream stream.

Parameters

p	point set being randomized
dimShift	dimension of the initial shift
stream	stream used for generating random shifts

Definition at line 64 of file RandShiftedMod1PointSet.java.

Member Function Documentation

◆ addRandomShift() [1/4]

void umontreal.ssj.hups.RandShiftedMod1PointSet.addRandomShift ( )

Refreshes all coordinates of the random shift, up to its current dimension.

Reimplemented from umontreal.ssj.hups.PointSet.

Definition at line 136 of file RandShiftedMod1PointSet.java.

◆ addRandomShift() [2/4]

void umontreal.ssj.hups.RandShiftedMod1PointSet.addRandomShift	(	int	d1,
		int	d2 )

Refreshes the random shift (generates new uniform values for the random shift coordinates) for coordinates d1 to d2-1.

Reimplemented from umontreal.ssj.hups.PointSet.

Definition at line 110 of file RandShiftedMod1PointSet.java.

◆ addRandomShift() [3/4]

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

Changes the stream used for the random shifts to stream, then refreshes the shift for coordinates d1 to d2-1.

Remarks: Richard: Il y a 4 méthodes addRandomShift. Peut-être faudrait-il en éliminer 2, comme dans PointSet.

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 88 of file RandShiftedMod1PointSet.java.

◆ addRandomShift() [4/4]

void umontreal.ssj.hups.RandShiftedMod1PointSet.addRandomShift ( RandomStream stream )

Changes the stream used for the random shifts to stream, then refreshes all coordinates of the random shift, up to its current dimension.

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 100 of file RandShiftedMod1PointSet.java.

◆ getCoordinate()

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

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

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 143 of file RandShiftedMod1PointSet.java.

◆ getShiftDimension()

int umontreal.ssj.hups.RandShiftedMod1PointSet.getShiftDimension ( )

Returns the number of dimensions of the current random shift.

Definition at line 77 of file RandShiftedMod1PointSet.java.

◆ iterator()

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

Returns a RandShiftedMod1PointSetIterator for this point set.

Reimplemented from umontreal.ssj.hups.ContainerPointSet.

Definition at line 162 of file RandShiftedMod1PointSet.java.

◆ toString()

String umontreal.ssj.hups.RandShiftedMod1PointSet.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 155 of file RandShiftedMod1PointSet.java.

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

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

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RandShiftedMod1PointSet()

Member Function Documentation

◆ addRandomShift() [1/4]

◆ addRandomShift() [2/4]

◆ addRandomShift() [3/4]

◆ addRandomShift() [4/4]

◆ getCoordinate()

◆ getShiftDimension()

◆ iterator()

◆ toString()