File: drivers.tex

package info (click to toggle)
spooles 2.2-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 18,824 kB
  • ctags: 3,665
  • sloc: ansic: 146,828; csh: 3,615; makefile: 2,045; perl: 70
file content (136 lines) | stat: -rw-r--r-- 5,289 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
\par
\section{Driver programs for the {\tt DSTree} object}
\label{section:DSTree:drivers}
\par
This section contains brief descriptions of the driver programs.
\par
%=======================================================================
\begin{enumerate}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIO msglvl msgFile inFile outFile
\end{verbatim}
This driver program reads and write {\tt DSTree} files, useful for
converting formatted files to binary files and vice versa.
One can also read in a {\tt DSTree} file and print out just the 
header information (see the {\tt DSTree\_writeStats()} method).
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt DSTree} object is written
to the message file.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt inFile} parameter is the input file for the {\tt DSTree}
object. It must be of the form {\tt *.dinpmtxf} or {\tt *.dinpmtxb}.
The {\tt DSTree} object is read from the file via the
{\tt DSTree\_readFromFile()} method.
\item
The {\tt outFile} parameter is the output file for the {\tt DSTree}
object. 
If {\tt outFile} is {\tt none} then the {\tt DSTree} object is not
written to a file. 
Otherwise, the {\tt DSTree\_writeToFile()} method is called to write
the object to 
a formatted file (if {\tt outFile} is of the form {\tt *.dinpmtxf}),
or
a binary file (if {\tt outFile} is of the form {\tt *.dinpmtxb}).
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
writeStagesIV msglvl msgFile inFile type outFile
\end{verbatim}
This driver program reads in a {\tt DSTree} from a file,
creates a stages {\tt IV} object and writes it to a file.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt DSTree} object is written
to the message file.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt inFile} parameter is the input file for the {\tt DSTree}
object. It must be of the form {\tt *.dstreef} or {\tt *.dstreeb}.
The {\tt DSTree} object is read from the file via the
{\tt DSTree\_readFromFile()} method.
\item
The {\tt type} parameter specifies which type of stages vector to
create. There are presently four supported types : 
{\tt ND}, {\tt ND2}, {\tt MS2} and {\tt ND3}.
See the stage methods 
in Section~\ref{subsection:DSTree:proto:stages}.
\item
The {\tt outFile} parameter is the output file for the stages {\tt IV}
object. 
If {\tt outFile} is {\tt none} then the {\tt IV} object is not
written to a file. 
Otherwise, the {\tt IV\_writeToFile()} method is called to write
the object to 
a formatted file (if {\tt outFile} is of the form {\tt *.ivf}),
or
a binary file (if {\tt outFile} is of the form {\tt *.ivb}).
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testDomWeightStages msglvl msgFile 
                    inDSTreeFile inGraphFile inCutoffDVfile outFile
\end{verbatim}
This driver program is used to create a stages vector based on
subtree weight.
It reads in three objects from files:
a {\tt DSTree} object, a {\tt Graph} object and a {\tt DV} object
that contains the cutoff vector,
then creates a stages {\tt IV} object and writes it to a file.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt DSTree} object is written
to the message file.
\item
The {\tt msgFile} parameter determines the message file --- if {\tt
msgFile} is {\tt stdout}, then the message file is {\it stdout},
otherwise a file is opened with {\it append} status to receive any
output data.
\item
The {\tt inDSTreeFile} parameter is the input file for the {\tt DSTree}
object. It must be of the form {\tt *.dstreef} or {\tt *.dstreeb}.
The {\tt DSTree} object is read from the file via the
{\tt DSTree\_readFromFile()} method.
\item
The {\tt inGraphFile} parameter is the input file for the {\tt Graph}
object. It must be of the form {\tt *.graphf} or {\tt *.graphb}.
The {\tt Graph} object is read from the file via the
{\tt Graph\_readFromFile()} method.
\item
The {\tt inCutoffDVfile} parameter is the input file for the cutoff
{\tt DV} object. 
It must be of the form {\tt *.dvf} or {\tt *.dvb}.
The {\tt DV} object is read from the file via the
{\tt DV\_readFromFile()} method.
\item
The {\tt outFile} parameter is the output file for the stages {\tt IV}
object. 
If {\tt outFile} is {\tt none} then the {\tt IV} object is not
written to a file. 
Otherwise, the {\tt IV\_writeToFile()} method is called to write
the object to 
a formatted file (if {\tt outFile} is of the form {\tt *.ivf}),
or
a binary file (if {\tt outFile} is of the form {\tt *.ivb}).
\end{itemize}
%-----------------------------------------------------------------------
\end{enumerate}