File: claqgs_8c.html

package info (click to toggle)
superlu 7.0.1%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,292 kB
  • sloc: ansic: 59,338; makefile: 413; csh: 141; f90: 125; fortran: 77
file content (246 lines) | stat: -rw-r--r-- 11,192 bytes parent folder | download
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
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SuperLU: SRC/claqgs.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">SuperLU<span id="projectnumber">&#160;7.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">claqgs.c File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Equlibrates a general sprase matrix.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;math.h&gt;</code><br />
<code>#include &quot;<a class="el" href="slu__cdefs_8h_source.html">slu_cdefs.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for claqgs.c:</div>
<div class="dyncontent">
<div class="center"><img src="claqgs_8c__incl.png" border="0" usemap="#aSRC_2claqgs_8c" alt=""/></div>
<map name="aSRC_2claqgs_8c" id="aSRC_2claqgs_8c">
<area shape="rect" title="Equlibrates a general sprase matrix." alt="" coords="228,5,331,32"/>
<area shape="rect" title=" " alt="" coords="5,155,68,181"/>
<area shape="rect" href="slu__cdefs_8h.html" title="Header file for real operations." alt="" coords="409,80,499,107"/>
<area shape="rect" title=" " alt="" coords="873,155,937,181"/>
<area shape="rect" title=" " alt="" coords="643,229,705,256"/>
<area shape="rect" title=" " alt="" coords="845,229,909,256"/>
<area shape="rect" title=" " alt="" coords="243,155,308,181"/>
<area shape="rect" title=" " alt="" coords="41,229,107,256"/>
<area shape="rect" href="slu__Cnames_8h.html" title="Macros defining how C routines will be called." alt="" coords="333,155,439,181"/>
<area shape="rect" href="superlu__config_8h.html" title=" " alt="" coords="463,155,583,181"/>
<area shape="rect" href="supermatrix_8h.html" title="Matrix type definitions." alt="" coords="608,155,711,181"/>
<area shape="rect" href="slu__util_8h.html" title="Utility header file." alt="" coords="143,155,218,181"/>
<area shape="rect" href="slu__scomplex_8h.html" title="Header file for complex operations." alt="" coords="735,155,848,181"/>
<area shape="rect" title=" " alt="" coords="319,229,389,256"/>
<area shape="rect" href="superlu__enum__consts_8h.html" title="enum constants header file" alt="" coords="131,229,295,256"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0656018abfc9fa2821827415f5d5ea57"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="claqgs_8c.html#a0656018abfc9fa2821827415f5d5ea57">THRESH</a>&#160;&#160;&#160;(0.1)</td></tr>
<tr class="separator:a0656018abfc9fa2821827415f5d5ea57"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0cf5dcef08d22df154acf807beb43ea1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="claqgs_8c.html#a0cf5dcef08d22df154acf807beb43ea1">claqgs</a> (<a class="el" href="structSuperMatrix.html">SuperMatrix</a> *<a class="el" href="zsymv_8c.html#af5d6242ff783dd9efca51eeec1c234f7">A</a>, float *r, float *c, float rowcnd, float colcnd, float amax, char *equed)</td></tr>
<tr class="separator:a0cf5dcef08d22df154acf807beb43ea1"><td class="memSeparator" colspan="2">&#160;</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>
<pre>
-- SuperLU routine (version 2.0) --
Univ. of California Berkeley, Xerox Palo Alto Research Center,
and Lawrence Berkeley National Lab.
November 15, 1997

Modified from LAPACK routine CLAQGE
</pre> </div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a0656018abfc9fa2821827415f5d5ea57" name="a0656018abfc9fa2821827415f5d5ea57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0656018abfc9fa2821827415f5d5ea57">&#9670;&nbsp;</a></span>THRESH</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define THRESH&#160;&#160;&#160;(0.1)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0cf5dcef08d22df154acf807beb43ea1" name="a0cf5dcef08d22df154acf807beb43ea1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cf5dcef08d22df154acf807beb43ea1">&#9670;&nbsp;</a></span>claqgs()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void claqgs </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structSuperMatrix.html">SuperMatrix</a> *&#160;</td>
          <td class="paramname"><em>A</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>rowcnd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>colcnd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>amax</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>equed</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre>
  Purpose   
  =======   

  CLAQGS equilibrates a general sparse M by N matrix A using the row and   
  scaling factors in the vectors R and C.   

  See <a class="el" href="supermatrix_8h.html" title="Matrix type definitions.">supermatrix.h</a> for the definition of '<a class="el" href="structSuperMatrix.html">SuperMatrix</a>' structure.

  Arguments   
  =========   

  A       (input/output) SuperMatrix*
          On exit, the equilibrated matrix.  See EQUED for the form of 
          the equilibrated matrix. The type of A can be:
         Stype = NC; Dtype = SLU_C; Mtype = GE.

  R       (input) float*, dimension (A-&gt;nrow)
          The row scale factors for A.

  C       (input) float*, dimension (A-&gt;ncol)
          The column scale factors for A.

  ROWCND  (input) float
          Ratio of the smallest R(i) to the largest R(i).

  COLCND  (input) float
          Ratio of the smallest C(i) to the largest C(i).

  AMAX    (input) float
          Absolute value of largest matrix entry.

  EQUED   (output) char*
          Specifies the form of equilibration that was done.   
          = 'N':  No equilibration   
          = 'R':  Row equilibration, i.e., A has been premultiplied by  
                  diag(R).   
          = 'C':  Column equilibration, i.e., A has been postmultiplied  
                  by diag(C).   
          = 'B':  Both row and column equilibration, i.e., A has been
                  replaced by diag(R) * A * diag(C).   

  Internal Parameters   
  ===================   

  THRESH is a threshold value used to decide if row or column scaling   
  should be done based on the ratio of the row or column scaling   
  factors.  If ROWCND &lt; THRESH, row scaling is done, and if   
  COLCND &lt; THRESH, column scaling is done.   

  LARGE and SMALL are threshold values used to decide if row scaling   
  should be done based on the absolute size of the largest matrix   
  element.  If AMAX &gt; LARGE or AMAX &lt; SMALL, row scaling is done.   

  ===================================================================== 
</pre> <div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="claqgs_8c_a0cf5dcef08d22df154acf807beb43ea1_cgraph.png" border="0" usemap="#aclaqgs_8c_a0cf5dcef08d22df154acf807beb43ea1_cgraph" alt=""/></div>
<map name="aclaqgs_8c_a0cf5dcef08d22df154acf807beb43ea1_cgraph" id="aclaqgs_8c_a0cf5dcef08d22df154acf807beb43ea1_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,65,32"/>
<area shape="rect" href="smach_8c.html#ac3a5d5fd52503ed62ddc9029bab917d5" title=" " alt="" coords="113,5,175,32"/>
<area shape="rect" href="input__error_8c.html#ad4e27444570b55672c6d20dc1adb12c0" title=" " alt="" coords="223,5,309,32"/>
</map>
</div>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>