package umontreal.iro.lecuyer.hups;
/* *
* Title:
* Description:
* Copyright: Copyright (c)
* Company:
* @author
* @version 1.6
*/
import java.io.*;
import java.net.URL;
import java.net.MalformedURLException;
import umontreal.iro.lecuyer.util.PrintfFormat;
/**
* This class allows us to read the parameters defining a digital net
* in base 2 either from a file, or from a URL address on the
* World Wide Web. See the documentation in
* {@link umontreal.iro.lecuyer.hups.DigitalNetFromFile DigitalNetFromFile}.
* The parameters used in building the net are those defined in class
* {@link umontreal.iro.lecuyer.hups.DigitalNetBase2 DigitalNetBase2}.
* The format of the data files must be the following (where B is any Cj):
* (see the format in guidehups.pdf)
*
* 
*
*
*
* For each dimension j, there must be a k-vector of 32-bit integers
* (the ai) corresponding to the columns of
* Cj. The
* correspondance is such that integer
*
* ai = 230(Cj)1i +229(Cj)2i + ... +231-r(Cj)ri.
*
*/
public class DigitalNetBase2FromFile extends DigitalNetBase2 {
private String filename;
// s is the effective dimension if > 0, otherwise it is dim
private void readData (Reader re, int r1, int s1)
throws IOException, NumberFormatException
{
try {
StreamTokenizer st = new StreamTokenizer (re);
if (st == null) return;
st.eolIsSignificant (false);
st.slashSlashComments (true);
int i = st.nextToken ();
if (i != StreamTokenizer.TT_NUMBER)
throw new NumberFormatException();
b = (int) st.nval;
st.nextToken (); numCols = (int) st.nval;
st.nextToken (); numRows = (int) st.nval;
st.nextToken (); numPoints = (int) st.nval;
st.nextToken (); dim = (int) st.nval;
if (dim < 1) {
System.err.println (PrintfFormat.NEWLINE +
"DigitalNetBase2FromFile: dimension dim <= 0");
throw new IllegalArgumentException ("dimension dim <= 0");
}
if (r1 > numRows)
throw new IllegalArgumentException (
"DigitalNetBase2FromFile: One must have r1 <= Max num rows");
if (s1 > dim) {
throw new IllegalArgumentException ("s1 is too large");
}
if (s1 > 0)
dim = s1;
if (r1 > 0)
numRows = r1;
if (b != 2) {
System.err.println (
"***** DigitalNetBase2FromFile: only base 2 allowed");
throw new IllegalArgumentException ("only base 2 allowed");
}
genMat = new int[dim * numCols];
for (i = 0; i < dim; i++)
for (int c = 0; c < numCols; c++) {
st.nextToken ();
genMat[i*numCols + c] = (int) st.nval;
}
} catch (NumberFormatException e) {
System.err.println (
" DigitalNetBase2FromFile: not a number " + e);
throw e;
}
}
private void maskRows (int r, int w) {
// Keep only the r most significant bits and set the others to 0.
int mask = (int) ((1L << r) - 1);
mask <<= MAXBITS - r;
for (int i = 0; i < dim; i++)
for (int c = 0; c < numCols; c++) {
genMat[i*numCols + c] &= mask;
genMat[i*numCols + c] >>= MAXBITS - w;
}
}
/**
* Constructs a digital net in base 2 after reading its parameters from file
* filename. See the documentation in
* {@link umontreal.iro.lecuyer.hups.DigitalNetFromFile 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 >= r1.
*
* @param filename Name of the file to be read
*
* @param r1 Number of rows for the generating matrices
*
* @param w Number of bits of resolution
*
* @param s1 Number of dimensions
*
*
*/
public DigitalNetBase2FromFile (String filename, int r1, int w, int s1)
throws IOException, MalformedURLException
{
super ();
if (w < r1 || w > MAXBITS)
throw new IllegalArgumentException (" Must have numRows <= w <= 31");
BufferedReader input;
if (filename.startsWith("http:") || filename.startsWith("ftp:"))
input = DigitalNetFromFile.openURL(filename);
else
input = DigitalNetFromFile.openFile(filename);
try {
readData (input, r1, s1);
} catch (NumberFormatException e) {
System.err.println (
" DigitalNetBase2FromFile: cannot read from " + filename);
throw e;
} catch (IOException e) {
System.err.println (
" DigitalNetBase2FromFile: cannot read from " + filename);
throw e;
}
input.close();
maskRows (numRows, w);
outDigits = w;
if (numCols >= MAXBITS)
throw new IllegalArgumentException (" Must have numCols < 31");
this.filename = filename;
int x = (1 << numCols);
if (x != numPoints) {
System.out.println ("numPoints != 2^k");
throw new IllegalArgumentException ("numPoints != 2^k");
}
// Compute the normalization factors.
normFactor = 1.0 / ((double) (1L << (outDigits)));
}
/**
* Same as {@link #DigitalNetBase2FromFile DigitalNetBase2FromFile}(filename, r, 31, s1) where
* s1 is the dimension and r is given in data file filename.
*
* @param filename Name of the file to be read
*
* @param s1 Number of dimensions
*
*/
public DigitalNetBase2FromFile (String filename, int s1)
throws IOException, MalformedURLException
{
this (filename, -1, 31, s1);
}
public String toString() {
StringBuffer sb = new StringBuffer ("File: " + filename +
PrintfFormat.NEWLINE);
sb.append (super.toString());
return sb.toString();
}
/**
* 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.
*
*/
public String toStringDetailed() {
StringBuffer sb = new StringBuffer (toString() + PrintfFormat.NEWLINE);
sb.append ("dim = " + dim + PrintfFormat.NEWLINE);
for (int i = 0; i < dim; i++) {
sb.append (PrintfFormat.NEWLINE + "// dim = " + (1 + i) +
PrintfFormat.NEWLINE);
for (int c = 0; c < numCols; c++)
sb.append (genMat[i*numCols + c] + PrintfFormat.NEWLINE);
}
sb.append ("--------------------------------" + PrintfFormat.NEWLINE);
return sb.toString ();
}
/**
* 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.
*
*/
public static String listDir (String dirname) throws IOException {
return DigitalNetFromFile.listDir(dirname);
}
}