This class permits one to read the parameters that define a digital net in base 2 either from a file, or from a URL address. More...
Inheritance diagram for DigitalNetBase2FromFile:
Collaboration diagram for DigitalNetBase2FromFile:
Public Member Functions | |
| DigitalNetBase2FromFile (String filename, int r1, int w, int s1) throws IOException, MalformedURLException | |
Constructs a digital net in base 2 after reading its parameters from file filename. More... | |
| DigitalNetBase2FromFile (String filename, int s1) throws IOException, MalformedURLException | |
Same as DigitalNetBase2FromFile(filename, r, 31, s1) where s1 is the dimension and r is given in data file filename. More... | |
| String | toString () |
| String | toStringDetailed () |
| Writes the parameters and the generating matrices of this digital net to a string. More... | |
 Public Member Functions inherited from DigitalNetBase2 | |
| void | printGeneratorMatrices (int s) |
| Prints the generator matrices as bit matrices in standard form for dimensions 1 to \(s\). More... | |
| void | printGeneratorMatricesTrans (int s) |
| Prints the generator matrices transposed in the form of integers for dimensions 1 to \(s\). More... | |
| double | getCoordinate (int i, int j) |
| double | getCoordinateNoGray (int i, int j) |
| PointSetIterator | iterator () |
Returns a DigitalNetBase2Iterator which enumerates the points using a Gray code. | |
| PointSetIterator | iteratorNoGray () |
| This iterator does not use the Gray code. More... | |
| String | toString () |
| void | clearRandomShift () |
| void | addRandomShift (int d1, int d2, RandomStream stream) |
| void | addRandomShift (RandomStream stream) |
| void | leftMatrixScramble (RandomStream stream) |
| void | iBinomialMatrixScramble (RandomStream stream) |
| void | stripedMatrixScramble (RandomStream stream) |
| void | rightMatrixScramble (RandomStream stream) |
| void | nestedUniformScramble (RandomStream stream, double[][] output) |
| Same as nestedUniformScramble(stream, output, 0) . | |
| void | nestedUniformScramble (RandomStream stream, double[][] output, int numBits) |
| Apply Owen's nested uniform scrambling. More... | |
| void | leftMatrixScrambleDiag (RandomStream stream) |
| void | leftMatrixScrambleFaurePermut (RandomStream stream, int sb) |
| void | leftMatrixScrambleFaurePermutDiag (RandomStream stream, int sb) |
| void | leftMatrixScrambleFaurePermutAll (RandomStream stream, int sb) |
| void | iBinomialMatrixScrambleFaurePermut (RandomStream stream, int sb) |
| void | iBinomialMatrixScrambleFaurePermutDiag (RandomStream stream, int sb) |
| void | iBinomialMatrixScrambleFaurePermutAll (RandomStream stream, int sb) |
| void | stripedMatrixScrambleFaurePermutAll (RandomStream stream, int sb) |
| Public Member Functions inherited from DigitalNet | |
| DigitalNet () | |
| Empty constructor. | |
| double | getCoordinate (int i, int j) |
| Returns \(u_{i',j}\), the coordinate \(j\) of point \(i'\), where \(i'\) is the Gray code for \(i\). More... | |
| PointSetIterator | iterator () |
| double | getCoordinateNoGray (int i, int j) |
| Returns \(u_{i,j}\), the coordinate \(j\) of point \(i\), the points being enumerated in the standard order (no Gray code). More... | |
| PointSetIterator | iteratorNoGray () |
| Returns an iterator that does not use the Gray code. More... | |
| void | addRandomShift (int d1, int d2, RandomStream stream) |
Generates a random digital shift for coordinates \(j\) from d1 to d2-1, using stream to generate the random numbers. More... | |
| void | addRandomShift (RandomStream stream) |
Same as addRandomShift(0, dim, stream), where dim is the dimension of the digital net. More... | |
| void | clearRandomShift () |
| Erases the current digital random shift, if any. | |
| String | toString () |
| Formats a string that contains information on this digital net. More... | |
| void | leftMatrixScramble (RandomStream stream) |
| Applies a linear scramble by multiplying each \(\mathbf{C}_j\) on the left by a \(w\times w\) nonsingular lower-triangular matrix. More... | |
| void | leftMatrixScrambleDiag (RandomStream stream) |
| Similar to leftMatrixScramble except that all the off-diagonal elements of the \(\mathbf{M}_j\) are 0. More... | |
| void | leftMatrixScrambleFaurePermut (RandomStream stream, int sb) |
| Similar to leftMatrixScramble except that the diagonal elements of each matrix \(\mathbf{M}_j\) are chosen from a restricted set of the best integers as calculated by Faure [59] . More... | |
| void | leftMatrixScrambleFaurePermutDiag (RandomStream stream, int sb) |
| Similar to leftMatrixScrambleFaurePermut except that all off-diagonal elements are 0. More... | |
| void | leftMatrixScrambleFaurePermutAll (RandomStream stream, int sb) |
| Similar to leftMatrixScrambleFaurePermut except that the elements under the diagonal are also chosen from the same restricted set as the diagonal elements. More... | |
| void | iBinomialMatrixScramble (RandomStream stream) |
| Applies the \(i\)-binomial matrix scramble proposed by Tezuka. More... | |
| void | iBinomialMatrixScrambleFaurePermut (RandomStream stream, int sb) |
| Similar to iBinomialMatrixScramble except that the diagonal elements of each matrix \(\mathbf{M}_j\) are chosen as in leftMatrixScrambleFaurePermut. More... | |
| void | iBinomialMatrixScrambleFaurePermutDiag (RandomStream stream, int sb) |
| Similar to iBinomialMatrixScrambleFaurePermut except that all the off-diagonal elements are 0. More... | |
| void | iBinomialMatrixScrambleFaurePermutAll (RandomStream stream, int sb) |
| Similar to iBinomialMatrixScrambleFaurePermut except that the elements under the diagonal are also chosen from the same restricted set as the diagonal elements. More... | |
| void | stripedMatrixScramble (RandomStream stream) |
| Applies the striped matrix scramble proposed by Owen. More... | |
| void | stripedMatrixScrambleFaurePermutAll (RandomStream stream, int sb) |
| Similar to stripedMatrixScramble except that the elements on and under the diagonal of each matrix \(\mathbf{M}_j\) are chosen as in leftMatrixScrambleFaurePermut. More... | |
| void | rightMatrixScramble (RandomStream stream) |
| Applies a linear scramble by multiplying each \(\mathbf{C}_j\) on the right by a single \(k\times k\) nonsingular upper-triangular matrix \(\mathbf{M}\), as suggested by Faure and Tezuka. More... | |
| void | unrandomize () |
| Restores the original generator matrices and removes the random shift. | |
| void | resetGeneratorMatrices () |
| Restores the original generator matrices. More... | |
| void | eraseOriginalGeneratorMatrices () |
| Erases the original generator matrices and replaces them by the current ones. More... | |
| void | printGeneratorMatrices (int s) |
| Prints the generator matrices in standard form for dimensions 1 to \(s\). | |
| 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... | |
Static Public Member Functions | |
| static String | listDir (String dirname) throws IOException |
Lists all files (or directories) in directory dirname. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from DigitalNet | |
| void | printMat (int N, int[][][] A, String name) |
| void | printMat0 (int[][] A, String name) |
| int | intToDigitsGray (int b, int i, int numDigits, int[] bary, int[] gray) |
| Protected Attributes inherited from DigitalNetBase2 | |
| int [] | genMat |
| int [] | digitalShift |
| Protected Attributes inherited from DigitalNet | |
| int | b = 0 |
| int | numCols = 0 |
| int | numRows = 0 |
| int | outDigits = 0 |
| int [][] | genMat |
| int [][] | digitalShift |
| double | normFactor |
| double [] | factor |
| 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 permits one to read the parameters that define a digital net in base 2 either from a file, or from a URL address.
See the documentation of umontreal.ssj.hups.DigitalNetFromFile. The parameters used in building the net are those defined in the class umontreal.ssj.hups.DigitalNetBase2. The format of the data files must be as follows, where \(B\) represents any generating matrix \(C_j\) (see the format in umontreal.ssj.hups):
// Any number of comment lines starting with //
\(2\) // Base
\(k\) // Number of columns
\(r\) // Number of rows
\(n\) // Number of points = \(2^k\)
\(s\) // Dimension of points
// dim = 1
\(a_1\) // \(= 2^{30}B_{11} + 2^{29}B_{21} + \cdots+ 2^{31 - r}B_{r1}\)
\(a_2\) // \(= 2^{30}B_{12} + 2^{29}B_{22} + \cdots+ 2^{31 - r}B_{r2}\)
\(\vdots\)
\(a_k\)
// dim = 2
\(\vdots\)
// dim = \(s\)
\(a_1\)
\(a_2\)
\(\vdots\)
\(a_k\)
For each dimension \(j\), there must be a \(k\)-dimensional vector of 32-bit integers (the \(a_i\)) corresponding to the columns of \(\mathbf{C}_j\). The correspondence is such that the integer \(a_i = 2^{30}(\mathbf{C}_j)_{1i} + 2^{29}(\mathbf{C}_j)_{2i} + \cdots+ 2^{31 - r}(\mathbf{C}_j)_{ri}\).
Constructor & Destructor Documentation
◆ DigitalNetBase2FromFile() [1/2]
| DigitalNetBase2FromFile | ( | String | filename, |
| int | r1, | ||
| int | w, | ||
| int | s1 | ||
| ) | throws IOException, MalformedURLException |
Constructs a digital net in base 2 after reading its parameters from file filename.
See the documentation in umontreal.ssj.hups.DigitalNetFromFile. Parameter w gives the number of bits of resolution, r1 is the number of rows, and s1 is the dimension. Restrictions: s1 must be less than the maximal dimension, and r1 less than the maximal number of rows in the data file. Also w \(\ge\) r1.
- Parameters
-
filename Name of the file to be read r1 Number of rows for the generating matrices w Number of bits of resolution s1 Number of dimensions
◆ DigitalNetBase2FromFile() [2/2]
| DigitalNetBase2FromFile | ( | String | filename, |
| int | s1 | ||
| ) | throws IOException, MalformedURLException |
Same as DigitalNetBase2FromFile(filename, r, 31, s1) where s1 is the dimension and r is given in data file filename.
- Parameters
-
filename Name of the file to be read s1 Number of dimensions
Member Function Documentation
◆ listDir()
|
static |
Lists all files (or directories) in directory dirname.
Only relative pathnames should be used. The files are parameter files used in defining digital nets. For example, calling listDir("") will give the list of the main data directory in SSJ, while calling listDir("Edel/OOA2") will give the list of all files in directory Edel/OOA2.
◆ toStringDetailed()
| String toStringDetailed | ( | ) |
Writes the parameters and the generating matrices of this digital net to a string.
This is useful to check that the file parameters have been read correctly.
The documentation for this class was generated from the following file:
- DigitalNetBase2FromFile.java
