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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
|
\par
\section{Driver programs for the {\tt SubMtx object}}
\label{section:SubMtx:drivers}
\par
%=======================================================================
\begin{enumerate}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
testIO msglvl msgFile inFile outFile
\end{verbatim}
This driver program reads in a {\tt SubMtx} object from {\tt inFile}
and writes out the object to {\tt outFile}
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output ---
taking {\tt msglvl >= 3} means the {\tt SubMtx} 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 SubMtx}
object. It must be of the form {\tt *.submtxf} or {\tt *.submtxb}.
The {\tt SubMtx} object is read from the file via the
{\tt SubMtx\_readFromFile()} method.
\item
The {\tt outFile} parameter is the output file for the {\tt SubMtx}
object. It must be of the form {\tt *.submtxf} or {\tt *.submtxb}.
The {\tt SubMtx} object is written to the file via the
{\tt SubMtx\_writeToFile()} method.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_scalevec msglvl msgFile type mode nrowA seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_scalevec\{1,2,3\}()} methods.
Use the script file {\tt do\_scalevec} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be one of 1 ({\tt SPOOLES\_REAL})
or 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
7 ({\tt SUBMTX\_DIAGONAL}),
8 ({\tt SUBMTX\_BLOCK\_DIAGONAL\_SYM}) or
9 ({\tt SUBMTX\_BLOCK\_DIAGONAL\_HERM}).
\item
The {\tt nrowA} parameter is the number of rows in the matrix.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_solve msglvl msgFile type mode nrowA nentA ncolB seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_solve()} method
which tests the solve
$AX = B$ when $A$ is diagonal or block diagonal,
and $(I + A)X = B$ otherwise ($A$ is strict upper or lower
triangular).
Use the script file {\tt do\_solve} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be one of 1 ({\tt SPOOLES\_REAL})
or 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
2 ({\tt SUBMTX\_SPARSE\_ROWS}),
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}),
5 ({\tt SUBMTX\_DENSE\_SUBROWS}),
6 ({\tt SUBMTX\_DENSE\_SUBCOLUMNS}),
7 ({\tt SUBMTX\_DIAGONAL}), \break
8 ({\tt SUBMTX\_BLOCK\_DIAGONAL\_SYM}) or
9 ({\tt SUBMTX\_BLOCK\_DIAGONAL\_HERM}).
\item
The {\tt nrowA} parameter is the number of rows in the matrix.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt ncolB} parameter is the number of columns in $B$.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_solveH msglvl msgFile type mode nrowA nentA ncolB seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_solve()} method
which tests the solve
$(I + A^H)X = B$ when $A$ is strict upper or lower triangular
and has dense subrows, dense subcolumns, sparse rows, or sparse
columns.
Use the script file {\tt do\_solveH} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
2 ({\tt SUBMTX\_SPARSE\_ROWS}),
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}),
5 ({\tt SUBMTX\_DENSE\_SUBROWS}) or
6 ({\tt SUBMTX\_DENSE\_SUBCOLUMNS}).
\item
The {\tt nrowA} parameter is the number of rows in the matrix.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt ncolB} parameter is the number of columns in $B$.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_solveT msglvl msgFile type mode nrowA nentA ncolB seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_solve()} method
which tests the solve
$(I + A^T)X = B$ when $A$ is strict upper or lower triangular
and has dense subrows, dense subcolumns, sparse rows, or sparse
columns.
Use the script file {\tt do\_solveT} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be one of 1 ({\tt SPOOLES\_REAL})
or 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
2 ({\tt SUBMTX\_SPARSE\_ROWS}),
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}),
5 ({\tt SUBMTX\_DENSE\_SUBROWS}) or
6 ({\tt SUBMTX\_DENSE\_SUBCOLUMNS}).
\item
The {\tt nrowA} parameter is the number of rows in the matrix.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt ncolB} parameter is the number of columns in $B$.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_solveupd msglvl msgFile type mode nrowA nentA ncolB seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_solveupd()} method
which tests the update $Y := Y - A * X$,
used in the forward solve.
$X$ and $Y$ have dense columns,
and $A$ has dense rows or columns or sparse rows or columns.
Use the script file {\tt do\_solveupd} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be one of 1 ({\tt SPOOLES\_REAL})
or 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
0 ({\tt SUBMTX\_DENSE\_ROWS}),
1 ({\tt SUBMTX\_DENSE\_COLUMNS}),
2 ({\tt SUBMTX\_SPARSE\_ROWS}) or
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}).
\item
The {\tt nrowY} parameter is the number of rows in $Y$.
\item
The {\tt ncolY} parameter is the number of columns in $Y$.
\item
The {\tt nrowA} parameter is the number of rows in $A$,
${\tt nrowA} \le {\tt nrowY}$.
\item
The {\tt ncolA} parameter is the number of columns in $A$,
${\tt ncolA} \le {\tt nrowX}$.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt nrowX} parameter is the number of rows in $X$,
${\tt nrowA} \le {\tt nrowY}$.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_solveupdH msglvl msgFile type mode nrowA nentA ncolB seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_solveupd()} method
which tests the update $Y := Y - A^H * X$,
used in the forward solve of a hermitian factorization.
$X$ and $Y$ have dense columns,
and $A$ has dense rows or columns or sparse rows or columns.
Use the script file {\tt do\_solveupdH} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
0 ({\tt SUBMTX\_DENSE\_ROWS}),
1 ({\tt SUBMTX\_DENSE\_COLUMNS}),
2 ({\tt SUBMTX\_SPARSE\_ROWS}) or
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}).
\item
The {\tt nrowY} parameter is the number of rows in $Y$.
\item
The {\tt ncolY} parameter is the number of columns in $Y$.
\item
The {\tt nrowA} parameter is the number of rows in $A$,
${\tt nrowA} \le {\tt nrowY}$.
\item
The {\tt ncolA} parameter is the number of columns in $A$,
${\tt ncolA} \le {\tt nrowX}$.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt nrowX} parameter is the number of rows in $X$,
${\tt nrowA} \le {\tt nrowY}$.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_solveupdT msglvl msgFile type mode nrowA nentA ncolB seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_solveupd()} method
which tests the update $Y := Y - A^T * X$,
used in the forward solve of a symmetric factorization.
$X$ and $Y$ have dense columns,
and $A$ has dense rows or columns or sparse rows or columns.
Use the script file {\tt do\_solveupdT} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be one of 1 ({\tt SPOOLES\_REAL})
or 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
0 ({\tt SUBMTX\_DENSE\_ROWS}),
1 ({\tt SUBMTX\_DENSE\_COLUMNS}),
2 ({\tt SUBMTX\_SPARSE\_ROWS}) or
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}).
\item
The {\tt nrowY} parameter is the number of rows in $Y$.
\item
The {\tt ncolY} parameter is the number of columns in $Y$.
\item
The {\tt nrowA} parameter is the number of rows in $A$,
${\tt nrowA} \le {\tt nrowY}$.
\item
The {\tt ncolA} parameter is the number of columns in $A$,
${\tt ncolA} \le {\tt nrowX}$.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt nrowX} parameter is the number of rows in $X$,
${\tt nrowA} \le {\tt nrowY}$.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\item
\begin{verbatim}
test_sort msglvl msgFile type mode nrowA ncolA nentA seed
\end{verbatim}
This driver program tests
the {\tt SubMtx\_sortRowsUp()}
and {\tt SubMtx\_sortColumnsUp()}
methods.
Use the script file {\tt do\_sort} for testing.
When the output file is loaded into matlab,
the last lines to the screen contain the errors.
\par
\begin{itemize}
\item
The {\tt msglvl} parameter determines the amount of output.
Use {\tt msglvl = 1} for just timing output.
\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 type} parameter must be one of 1 ({\tt SPOOLES\_REAL})
or 2 ({\tt SPOOLES\_COMPLEX}).
\item
The {\tt mode} parameter must be one of
0 ({\tt SUBMTX\_DENSE\_ROWS}),
1 ({\tt SUBMTX\_DENSE\_COLUMNS}),
2 ({\tt SUBMTX\_SPARSE\_ROWS}) or
3 ({\tt SUBMTX\_SPARSE\_COLUMNS}).
\item
The {\tt nrowA} parameter is the number of rows in $A$.
\item
The {\tt ncolA} parameter is the number of columns in $A$.
\item
The {\tt nentA} parameter is the number of nonzero entries in the
submatrix, when appropriate.
\item
The {\tt seed} parameter is a random number seed.
\end{itemize}
%-----------------------------------------------------------------------
\end{enumerate}
|
