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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>SuperLU: SRC/cgssvx.c File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>SRC/cgssvx.c File Reference</h1>Solves the system of linear equations A*X=B or A'*X=B. <a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="slu__cdefs_8h-source.html">slu_cdefs.h</a>"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cgssvx_8c.html#f659b3121feb5ebd8810a5868d3bca12">cgssvx</a> (<a class="el" href="structsuperlu__options__t.html">superlu_options_t</a> *options, <a class="el" href="structSuperMatrix.html">SuperMatrix</a> *<a class="el" href="ilu__zdrop__row_8c.html#c900805a486cbb8489e3c176ed6e0d8e">A</a>, int *perm_c, int *perm_r, int *etree, char *equed, float *R, float *C, <a class="el" href="structSuperMatrix.html">SuperMatrix</a> *L, <a class="el" href="structSuperMatrix.html">SuperMatrix</a> *U, void *work, int lwork, <a class="el" href="structSuperMatrix.html">SuperMatrix</a> *B, <a class="el" href="structSuperMatrix.html">SuperMatrix</a> *X, float *recip_pivot_growth, float *rcond, float *ferr, float *berr, <a class="el" href="structmem__usage__t.html">mem_usage_t</a> *mem_usage, <a class="el" href="structSuperLUStat__t.html">SuperLUStat_t</a> *stat, int *info)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<pre>
-- SuperLU routine (version 3.0) --
Univ. of California Berkeley, Xerox Palo Alto Research Center,
and Lawrence Berkeley National Lab.
October 15, 2003
</pre> <hr><h2>Function Documentation</h2>
<a class="anchor" name="f659b3121feb5ebd8810a5868d3bca12"></a><!-- doxytag: member="cgssvx.c::cgssvx" ref="f659b3121feb5ebd8810a5868d3bca12" args="(superlu_options_t *options, SuperMatrix *A, int *perm_c, int *perm_r, int *etree, char *equed, float *R, float *C, SuperMatrix *L, SuperMatrix *U, void *work, int lwork, SuperMatrix *B, SuperMatrix *X, float *recip_pivot_growth, float *rcond, float *ferr, float *berr, mem_usage_t *mem_usage, SuperLUStat_t *stat, int *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cgssvx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsuperlu__options__t.html">superlu_options_t</a> * </td>
<td class="paramname"> <em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSuperMatrix.html">SuperMatrix</a> * </td>
<td class="paramname"> <em>A</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>perm_c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>perm_r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>etree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>equed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>R</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>C</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSuperMatrix.html">SuperMatrix</a> * </td>
<td class="paramname"> <em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSuperMatrix.html">SuperMatrix</a> * </td>
<td class="paramname"> <em>U</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>work</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>lwork</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSuperMatrix.html">SuperMatrix</a> * </td>
<td class="paramname"> <em>B</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSuperMatrix.html">SuperMatrix</a> * </td>
<td class="paramname"> <em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>recip_pivot_growth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>rcond</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>ferr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>berr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmem__usage__t.html">mem_usage_t</a> * </td>
<td class="paramname"> <em>mem_usage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSuperLUStat__t.html">SuperLUStat_t</a> * </td>
<td class="paramname"> <em>stat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>info</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<pre>
Purpose
=======</pre><p>
<pre> CGSSVX solves the system of linear equations A*X=B or A'*X=B, using
the LU factorization from <a class="el" href="cgstrf_8c.html#9c9f2ce12946612c7426a10352ac5984">cgstrf()</a>. Error bounds on the solution and
a condition estimate are also provided. It performs the following steps:</pre><p>
<pre> 1. If A is stored column-wise (A->Stype = SLU_NC):</pre><p>
<pre> 1.1. If options->Equil = YES, scaling factors are computed to
equilibrate the system:
options->Trans = NOTRANS:
diag(R)*A*diag(C) *inv(diag(C))*X = diag(R)*B
options->Trans = TRANS:
(diag(R)*A*diag(C))**T *inv(diag(R))*X = diag(C)*B
options->Trans = CONJ:
(diag(R)*A*diag(C))**H *inv(diag(R))*X = diag(C)*B
Whether or not the system will be equilibrated depends on the
scaling of the matrix A, but if equilibration is used, A is
overwritten by diag(R)*A*diag(C) and B by diag(R)*B
(if options->Trans=NOTRANS) or diag(C)*B (if options->Trans
= TRANS or CONJ).</pre><p>
<pre> 1.2. Permute columns of A, forming A*Pc, where Pc is a permutation
matrix that usually preserves sparsity.
For more details of this step, see <a class="el" href="sp__preorder_8c.html" title="Permute and performs functions on columns of orginal matrix.">sp_preorder.c</a>.</pre><p>
<pre> 1.3. If options->Fact != FACTORED, the LU decomposition is used to
factor the matrix A (after equilibration if options->Equil = YES)
as Pr*A*Pc = L*U, with Pr determined by partial pivoting.</pre><p>
<pre> 1.4. Compute the reciprocal pivot growth factor.</pre><p>
<pre> 1.5. If some U(i,i) = 0, so that U is exactly singular, then the
routine returns with info = i. Otherwise, the factored form of
A is used to estimate the condition number of the matrix A. If
the reciprocal of the condition number is less than machine
precision, info = A->ncol+1 is returned as a warning, but the
routine still goes on to solve for X and computes error bounds
as described below.</pre><p>
<pre> 1.6. The system of equations is solved for X using the factored form
of A.</pre><p>
<pre> 1.7. If options->IterRefine != NOREFINE, iterative refinement is
applied to improve the computed solution matrix and calculate
error bounds and backward error estimates for it.</pre><p>
<pre> 1.8. If equilibration was used, the matrix X is premultiplied by
diag(C) (if options->Trans = NOTRANS) or diag(R)
(if options->Trans = TRANS or CONJ) so that it solves the
original system before equilibration.</pre><p>
<pre> 2. If A is stored row-wise (A->Stype = SLU_NR), apply the above algorithm
to the transpose of A:</pre><p>
<pre> 2.1. If options->Equil = YES, scaling factors are computed to
equilibrate the system:
options->Trans = NOTRANS:
diag(R)*A*diag(C) *inv(diag(C))*X = diag(R)*B
options->Trans = TRANS:
(diag(R)*A*diag(C))**T *inv(diag(R))*X = diag(C)*B
options->Trans = CONJ:
(diag(R)*A*diag(C))**H *inv(diag(R))*X = diag(C)*B
Whether or not the system will be equilibrated depends on the
scaling of the matrix A, but if equilibration is used, A' is
overwritten by diag(R)*A'*diag(C) and B by diag(R)*B
(if trans='N') or diag(C)*B (if trans = 'T' or 'C').</pre><p>
<pre> 2.2. Permute columns of transpose(A) (rows of A),
forming transpose(A)*Pc, where Pc is a permutation matrix that
usually preserves sparsity.
For more details of this step, see <a class="el" href="sp__preorder_8c.html" title="Permute and performs functions on columns of orginal matrix.">sp_preorder.c</a>.</pre><p>
<pre> 2.3. If options->Fact != FACTORED, the LU decomposition is used to
factor the transpose(A) (after equilibration if
options->Fact = YES) as Pr*transpose(A)*Pc = L*U with the
permutation Pr determined by partial pivoting.</pre><p>
<pre> 2.4. Compute the reciprocal pivot growth factor.</pre><p>
<pre> 2.5. If some U(i,i) = 0, so that U is exactly singular, then the
routine returns with info = i. Otherwise, the factored form
of transpose(A) is used to estimate the condition number of the
matrix A. If the reciprocal of the condition number
is less than machine precision, info = A->nrow+1 is returned as
a warning, but the routine still goes on to solve for X and
computes error bounds as described below.</pre><p>
<pre> 2.6. The system of equations is solved for X using the factored form
of transpose(A).</pre><p>
<pre> 2.7. If options->IterRefine != NOREFINE, iterative refinement is
applied to improve the computed solution matrix and calculate
error bounds and backward error estimates for it.</pre><p>
<pre> 2.8. If equilibration was used, the matrix X is premultiplied by
diag(C) (if options->Trans = NOTRANS) or diag(R)
(if options->Trans = TRANS or CONJ) so that it solves the
original system before equilibration.</pre><p>
<pre> See <a class="el" href="supermatrix_8h.html" title="Defines matrix types.">supermatrix.h</a> for the definition of 'SuperMatrix' structure.</pre><p>
<pre> Arguments
=========</pre><p>
<pre> options (input) superlu_options_t*
The structure defines the input parameters to control
how the LU decomposition will be performed and how the
system will be solved.</pre><p>
<pre> A (input/output) SuperMatrix*
Matrix A in A*X=B, of dimension (A->nrow, A->ncol). The number
of the linear equations is A->nrow. Currently, the type of A can be:
Stype = SLU_NC or SLU_NR, Dtype = SLU_D, Mtype = SLU_GE.
In the future, more general A may be handled.</pre><p>
<pre> On entry, If options->Fact = FACTORED and equed is not 'N',
then A must have been equilibrated by the scaling factors in
R and/or C.
On exit, A is not modified if options->Equil = NO, or if
options->Equil = YES but equed = 'N' on exit.
Otherwise, if options->Equil = YES and equed is not 'N',
A is scaled as follows:
If A->Stype = SLU_NC:
equed = 'R': A := diag(R) * A
equed = 'C': A := A * diag(C)
equed = 'B': A := diag(R) * A * diag(C).
If A->Stype = SLU_NR:
equed = 'R': transpose(A) := diag(R) * transpose(A)
equed = 'C': transpose(A) := transpose(A) * diag(C)
equed = 'B': transpose(A) := diag(R) * transpose(A) * diag(C).</pre><p>
<pre> perm_c (input/output) int*
If A->Stype = SLU_NC, Column permutation vector of size A->ncol,
which defines the permutation matrix Pc; perm_c[i] = j means
column i of A is in position j in A*Pc.
On exit, perm_c may be overwritten by the product of the input
perm_c and a permutation that postorders the elimination tree
of Pc'*A'*A*Pc; perm_c is not changed if the elimination tree
is already in postorder.</pre><p>
<pre> If A->Stype = SLU_NR, column permutation vector of size A->nrow,
which describes permutation of columns of transpose(A)
(rows of A) as described above.</pre><p>
<pre> perm_r (input/output) int*
If A->Stype = SLU_NC, row permutation vector of size A->nrow,
which defines the permutation matrix Pr, and is determined
by partial pivoting. perm_r[i] = j means row i of A is in
position j in Pr*A.</pre><p>
<pre> If A->Stype = SLU_NR, permutation vector of size A->ncol, which
determines permutation of rows of transpose(A)
(columns of A) as described above.</pre><p>
<pre> If options->Fact = SamePattern_SameRowPerm, the pivoting routine
will try to use the input perm_r, unless a certain threshold
criterion is violated. In that case, perm_r is overwritten by a
new permutation determined by partial pivoting or diagonal
threshold pivoting.
Otherwise, perm_r is output argument.</pre><p>
<pre> etree (input/output) int*, dimension (A->ncol)
Elimination tree of Pc'*A'*A*Pc.
If options->Fact != FACTORED and options->Fact != DOFACT,
etree is an input argument, otherwise it is an output argument.
Note: etree is a vector of parent pointers for a forest whose
vertices are the integers 0 to A->ncol-1; etree[root]==A->ncol.</pre><p>
<pre> equed (input/output) char*
Specifies the form of equilibration that was done.
= 'N': No equilibration.
= 'R': Row equilibration, i.e., A was premultiplied by diag(R).
= 'C': Column equilibration, i.e., A was postmultiplied by diag(C).
= 'B': Both row and column equilibration, i.e., A was replaced
by diag(R)*A*diag(C).
If options->Fact = FACTORED, equed is an input argument,
otherwise it is an output argument.</pre><p>
<pre> R (input/output) float*, dimension (A->nrow)
The row scale factors for A or transpose(A).
If equed = 'R' or 'B', A (if A->Stype = SLU_NC) or transpose(A)
(if A->Stype = SLU_NR) is multiplied on the left by diag(R).
If equed = 'N' or 'C', R is not accessed.
If options->Fact = FACTORED, R is an input argument,
otherwise, R is output.
If options->zFact = FACTORED and equed = 'R' or 'B', each element
of R must be positive.</pre><p>
<pre> C (input/output) float*, dimension (A->ncol)
The column scale factors for A or transpose(A).
If equed = 'C' or 'B', A (if A->Stype = SLU_NC) or transpose(A)
(if A->Stype = SLU_NR) is multiplied on the right by diag(C).
If equed = 'N' or 'R', C is not accessed.
If options->Fact = FACTORED, C is an input argument,
otherwise, C is output.
If options->Fact = FACTORED and equed = 'C' or 'B', each element
of C must be positive.</pre><p>
<pre> L (output) SuperMatrix*
The factor L from the factorization
Pr*A*Pc=L*U (if A->Stype SLU_= NC) or
Pr*transpose(A)*Pc=L*U (if A->Stype = SLU_NR).
Uses compressed row subscripts storage for supernodes, i.e.,
L has types: Stype = SLU_SC, Dtype = SLU_C, Mtype = SLU_TRLU.</pre><p>
<pre> U (output) SuperMatrix*
The factor U from the factorization
Pr*A*Pc=L*U (if A->Stype = SLU_NC) or
Pr*transpose(A)*Pc=L*U (if A->Stype = SLU_NR).
Uses column-wise storage scheme, i.e., U has types:
Stype = SLU_NC, Dtype = SLU_C, Mtype = SLU_TRU.</pre><p>
<pre> work (workspace/output) void*, size (lwork) (in bytes)
User supplied workspace, should be large enough
to hold data structures for factors L and U.
On exit, if fact is not 'F', L and U point to this array.</pre><p>
<pre> lwork (input) int
Specifies the size of work array in bytes.
= 0: allocate space internally by system malloc;
> 0: use user-supplied work array of length lwork in bytes,
returns error if space runs out.
= -1: the routine guesses the amount of space needed without
performing the factorization, and returns it in
mem_usage->total_needed; no other side effects.</pre><p>
<pre> See argument 'mem_usage' for memory usage statistics.</pre><p>
<pre> B (input/output) SuperMatrix*
B has types: Stype = SLU_DN, Dtype = SLU_C, Mtype = SLU_GE.
On entry, the right hand side matrix.
If B->ncol = 0, only LU decomposition is performed, the triangular
solve is skipped.
On exit,
if equed = 'N', B is not modified; otherwise
if A->Stype = SLU_NC:
if options->Trans = NOTRANS and equed = 'R' or 'B',
B is overwritten by diag(R)*B;
if options->Trans = TRANS or CONJ and equed = 'C' of 'B',
B is overwritten by diag(C)*B;
if A->Stype = SLU_NR:
if options->Trans = NOTRANS and equed = 'C' or 'B',
B is overwritten by diag(C)*B;
if options->Trans = TRANS or CONJ and equed = 'R' of 'B',
B is overwritten by diag(R)*B.</pre><p>
<pre> X (output) SuperMatrix*
X has types: Stype = SLU_DN, Dtype = SLU_C, Mtype = SLU_GE.
If info = 0 or info = A->ncol+1, X contains the solution matrix
to the original system of equations. Note that A and B are modified
on exit if equed is not 'N', and the solution to the equilibrated
system is inv(diag(C))*X if options->Trans = NOTRANS and
equed = 'C' or 'B', or inv(diag(R))*X if options->Trans = 'T' or 'C'
and equed = 'R' or 'B'.</pre><p>
<pre> recip_pivot_growth (output) float*
The reciprocal pivot growth factor max_j( norm(A_j)/norm(U_j) ).
The infinity norm is used. If recip_pivot_growth is much less
than 1, the stability of the LU factorization could be poor.</pre><p>
<pre> rcond (output) float*
The estimate of the reciprocal condition number of the matrix A
after equilibration (if done). If rcond is less than the machine
precision (in particular, if rcond = 0), the matrix is singular
to working precision. This condition is indicated by a return
code of info > 0.</pre><p>
<pre> FERR (output) float*, dimension (B->ncol)
The estimated forward error bound for each solution vector
X(j) (the j-th column of the solution matrix X).
If XTRUE is the true solution corresponding to X(j), FERR(j)
is an estimated upper bound for the magnitude of the largest
element in (X(j) - XTRUE) divided by the magnitude of the
largest element in X(j). The estimate is as reliable as
the estimate for RCOND, and is almost always a slight
overestimate of the true error.
If options->IterRefine = NOREFINE, ferr = 1.0.</pre><p>
<pre> BERR (output) float*, dimension (B->ncol)
The componentwise relative backward error of each solution
vector X(j) (i.e., the smallest relative change in
any element of A or B that makes X(j) an exact solution).
If options->IterRefine = NOREFINE, berr = 1.0.</pre><p>
<pre> mem_usage (output) mem_usage_t*
Record the memory usage statistics, consisting of following fields:<ul>
<li>for_lu (float)
The amount of space used in bytes for L data structures.</li><li>total_needed (float)
The amount of space needed in bytes to perform factorization.</li><li>expansions (int)
The number of memory expansions during the LU factorization.</li></ul>
</pre><p>
<pre> stat (output) SuperLUStat_t*
Record the statistics on runtime and floating-point operation count.
See <a class="el" href="slu__util_8h.html" title="Utility header file.">slu_util.h</a> for the definition of 'SuperLUStat_t'.</pre><p>
<pre> info (output) int*
= 0: successful exit
< 0: if info = -i, the i-th argument had an illegal value
> 0: if info = i, and i is
<= A->ncol: U(i,i) is exactly zero. The factorization has
been completed, but the factor U is exactly
singular, so the solution and error bounds
could not be computed.
= A->ncol+1: U is nonsingular, but RCOND is less than machine
precision, meaning that the matrix is singular to
working precision. Nevertheless, the solution and
error bounds are computed because there are a number
of situations where the computed solution can be more
accurate than the value of RCOND would suggest.
> A->ncol+1: number of bytes allocated when memory allocation
failure occurred, plus A->ncol.
</pre>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Aug 25 13:43:49 2011 for SuperLU by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
|
