umontreal.iro.lecuyer.hups
Class DigitalNetFromFile

java.lang.Object
  umontreal.iro.lecuyer.hups.PointSet
      umontreal.iro.lecuyer.hups.DigitalNet
          umontreal.iro.lecuyer.hups.DigitalNetFromFile

public class DigitalNetFromFile
extends DigitalNet

This class allows us to read the parameters defining a digital net either from a file, or from a URL address on the World Wide Web. The parameters used in building the net are those defined in class DigitalNet. The format of the data files must be the following: (see the format in guidehups.pdf)

The figure above gives the general format of the data file needed by DigitalNetFromFile. The values of the parameters on the left must appear in the file as integers. On the right of each parameter, there is an optional comment that is disregarded by the reader program. In general, the Java line comments // are accepted anywhere and will ensure that the rest of the line is dropped by the reader. Blank lines are also disregarded by the reader program. For each dimension, there must be a k×r matrix of integers in {0, 1,…, b - 1} (note that the matrices must appear in transposed form).

The predefined files in SSJ are kept in different directories depending on the criteria used in the searches for the parameters defining the digital net. Each file contains the parameters for a specific digital net. One may get a list of all available files in a directory by using method listDir below. The name of the files gives information about the main parameters of the digital net. For example, the file named Edel/OOA2/B3S13R9C9St6 contains the parameters for a digital net proposed by Yves Edel (see http://www.mathi.uni-heidelberg.de/~yves/Matritzen/OOAs) based on ordered orthogonal arrays; the digital net has base B = 3, dimension S = 13, the generating matrices have R = 9 rows and C = 9 columns, and the strength of the net is St = 6. At the moment, there are no existing subdirectories of predefined files in SSJ; the files have all been stocked at the address http://www.iro.umontreal.ca/~simardr/ssj/data.html.

Constructor Summary

DigitalNetFromFile(String filename, int s)

DigitalNetFromFile(String filename, int r1, int w, int s1)

Method Summary

static String	listDir(String dirname) Lists all files (or directories) in directory dirname.
static void	listDirHTML(String dirname, String filename)
String	toString() Formats a string that contains the information about the point set.
String	toStringDetailed() Writes the parameters and the generating matrices of this digital net to a string.

Methods inherited from class umontreal.iro.lecuyer.hups.DigitalNet

addRandomShift, addRandomShift, clearRandomShift, eraseOriginalGeneratorMatrices, getCoordinate, getCoordinateNoGray, iBinomialMatrixScramble, iBinomialMatrixScrambleFaurePermut, iBinomialMatrixScrambleFaurePermutAll, iBinomialMatrixScrambleFaurePermutDiag, iterator, iteratorNoGray, leftMatrixScramble, leftMatrixScrambleDiag, leftMatrixScrambleFaurePermut, leftMatrixScrambleFaurePermutAll, leftMatrixScrambleFaurePermutDiag, leftMatrixScrambleRest, printGeneratorMatrices, resetGeneratorMatrices, rightMatrixScramble, stripedMatrixScramble, stripedMatrixScrambleFaurePermutAll, unrandomize

Methods inherited from class umontreal.iro.lecuyer.hups.PointSet

addRandomShift, addRandomShift, formatPoints, formatPoints, getDimension, getNumPoints, randomize, randomize, randomize, randomize

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DigitalNetFromFile

public DigitalNetFromFile(String filename,
                          int r1,
                          int w,
                          int s1)
                   throws MalformedURLException,
                          IOException

Throws:

MalformedURLException

IOException

DigitalNetFromFile

public DigitalNetFromFile(String filename,
                          int s)
                   throws MalformedURLException,
                          IOException

Throws:

MalformedURLException

IOException

Method Detail

toString

public String toString()

Description copied from class: PointSet

Formats a string that contains the information about the point set.

Overrides:

toString in class DigitalNet

Returns:

string representation of the point set information

toStringDetailed

public 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.

listDir

public static String listDir(String dirname)
                      throws IOException

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.

Throws:

IOException

listDirHTML

public static void listDirHTML(String dirname,
                               String filename)
                        throws IOException

Throws:

IOException