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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SuperLU: SRC/sp_preorder.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SuperLU
 <span id="projectnumber">5.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_1e771ff450ae847412a8c28572c155bb.html">SRC</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">sp_preorder.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Permute and performs functions on columns of orginal matrix.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="slu__ddefs_8h_source.html">slu_ddefs.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sp_preorder.c:</div>
<div class="dyncontent">
<div class="center"><img src="sp__preorder_8c__incl.png" border="0" usemap="#SRC_2sp__preorder_8c" alt=""/></div>
<map name="SRC_2sp__preorder_8c" id="SRC_2sp__preorder_8c">
<area shape="rect" title="Permute and performs functions on columns of orginal matrix." alt="" coords="251,5,387,32"/>
<area shape="rect" href="slu__ddefs_8h.html" title="Header file for real operations." alt="" coords="274,80,365,107"/>
<area shape="rect" title=" " alt="" coords="5,155,68,181"/>
<area shape="rect" title=" " alt="" coords="93,155,157,181"/>
<area shape="rect" title=" " alt="" coords="95,229,157,256"/>
<area shape="rect" title=" " alt="" coords="181,229,245,256"/>
<area shape="rect" title=" " alt="" coords="432,155,497,181"/>
<area shape="rect" title=" " alt="" coords="552,229,617,256"/>
<area shape="rect" href="slu__Cnames_8h.html" title="Macros defining how C routines will be called." alt="" coords="522,155,629,181"/>
<area shape="rect" href="supermatrix_8h.html" title="Matrix type definitions." alt="" coords="653,155,756,181"/>
<area shape="rect" href="slu__util_8h.html" title="Utility header file." alt="" coords="282,155,357,181"/>
<area shape="rect" title=" " alt="" coords="458,229,527,256"/>
<area shape="rect" href="superlu__enum__consts_8h.html" title="enum constants header file" alt="" coords="269,229,433,256"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad3a9a45f02456022c7eba79e17e215bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sp__preorder_8c.html#ad3a9a45f02456022c7eba79e17e215bc">sp_preorder</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#ac900805a486cbb8489e3c176ed6e0d8e">A</a>, int *perm_c, int *etree, <a class="el" href="structSuperMatrix.html">SuperMatrix</a> *AC)</td></tr>
<tr class="separator:ad3a9a45f02456022c7eba79e17e215bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac79059104ae6abf212c41986820d358c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sp__preorder_8c.html#ac79059104ae6abf212c41986820d358c">check_perm</a> (char *what, int n, int *perm)</td></tr>
<tr class="separator:ac79059104ae6abf212c41986820d358c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Copyright (c) 2003, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from U.S. Dept. of Energy)</p>
<p>All rights reserved.</p>
<p>The source code is distributed under BSD license, see the file License.txt at the top-level directory.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac79059104ae6abf212c41986820d358c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac79059104ae6abf212c41986820d358c">◆ </a></span>check_perm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int check_perm </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>what</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>perm</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad3a9a45f02456022c7eba79e17e215bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3a9a45f02456022c7eba79e17e215bc">◆ </a></span>sp_preorder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sp_preorder </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>etree</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>AC</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre>
Purpose
=======</pre><pre><a class="el" href="sp__preorder_8c.html#ad3a9a45f02456022c7eba79e17e215bc">sp_preorder()</a> permutes the columns of the original matrix. It performs
the following steps:</pre><pre> 1. Apply column permutation perm_c[] to A's column pointers to form AC;</pre><pre> 2. If options->Fact = DOFACT, then
(1) Compute column elimination tree etree[] of AC'AC;
(2) Post order etree[] to get a postordered elimination tree etree[],
and a postorder permutation post[];
(3) Apply post[] permutation to columns of AC;
(4) Overwrite perm_c[] with the product perm_c * post.</pre><pre>Arguments
=========</pre><pre>options (input) superlu_options_t*
Specifies whether or not the elimination tree will be re-used.
If options->Fact == DOFACT, this means first time factor A,
etree is computed, postered, and output.
Otherwise, re-factor A, etree is input, unchanged on exit.</pre><pre>A (input) 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 = NC or SLU_NCP; Mtype = SLU_GE.
In the future, more general A may be handled.</pre><pre>perm_c (input/output) int*
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.
If options->Fact == DOFACT, perm_c is both input and output.
On output, it is changed according to a postorder of etree.
Otherwise, perm_c is input.</pre><pre>etree (input/output) int*
Elimination tree of Pc'*A'*A*Pc, dimension A->ncol.
If options->Fact == DOFACT, etree is an output argument,
otherwise it is an input 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><pre>AC (output) SuperMatrix*
The resulting matrix after applied the column permutation
perm_c[] to matrix A. The type of AC can be:
Stype = SLU_NCP; Dtype = A->Dtype; Mtype = SLU_GE.
</pre> <div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="sp__preorder_8c_ad3a9a45f02456022c7eba79e17e215bc_cgraph.png" border="0" usemap="#sp__preorder_8c_ad3a9a45f02456022c7eba79e17e215bc_cgraph" alt=""/></div>
<map name="sp__preorder_8c_ad3a9a45f02456022c7eba79e17e215bc_cgraph" id="sp__preorder_8c_ad3a9a45f02456022c7eba79e17e215bc_cgraph">
<area shape="rect" title=" " alt="" coords="5,132,99,159"/>
<area shape="rect" href="slu__util_8h.html#a8a3ba6cbe163f9c12f6f10ee8ba98fc7" title=" " alt="" coords="151,5,249,32"/>
<area shape="rect" href="sp__preorder_8c.html#ac79059104ae6abf212c41986820d358c" title=" " alt="" coords="153,56,247,83"/>
<area shape="rect" href="get__perm__c_8c.html#a486ee50799ff66abe91efa46a5950a57" title=" " alt="" coords="160,107,240,133"/>
<area shape="rect" href="sp__coletree_8c.html#a657d6b291654432e815392c2a00d2b84" title=" " alt="" coords="151,208,249,235"/>
<area shape="rect" href="slu__util_8h.html#af8198f26bef3c82fbb8601fc5a8e0d9e" title=" " alt="" coords="155,157,245,184"/>
<area shape="rect" href="slu__util_8h.html#a44084fde835d2ccaa25e9fd942a72b7a" title=" " alt="" coords="147,385,253,412"/>
<area shape="rect" href="sp__coletree_8c.html#a45fdfbf54106113728e1a036977ccf5b" title=" " alt="" coords="500,208,592,235"/>
<area shape="rect" href="sp__coletree_8c.html#a679285dead1583f96db3c978735de380" title=" " alt="" coords="301,107,452,133"/>
<area shape="rect" href="sp__coletree_8c.html#a6ecd760efd6eec938f69c6d692d6ddae" title=" " alt="" coords="337,259,417,285"/>
<area shape="rect" href="sp__coletree_8c.html#a7cdfbecc1ca23ee1cc298897bd64a45c" title=" " alt="" coords="355,56,399,83"/>
<area shape="rect" href="sp__coletree_8c.html#ab7bc8447f8976dbb19c60dc2e1a12905" title=" " alt="" coords="355,157,398,184"/>
<area shape="rect" href="sp__coletree_8c.html#aa34f31c4fe6ec2e5ee33f3d04ad9c209" title=" " alt="" coords="305,208,449,235"/>
<area shape="rect" href="sp__coletree_8c.html#a9da0c72a7b8eaf7a2a69fb6c3340131a" title=" " alt="" coords="351,461,402,488"/>
<area shape="rect" href="sp__coletree_8c.html#a7fec305add1f9f4c611eacdb2b744bfd" title=" " alt="" coords="341,411,412,437"/>
</map>
</div>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
