File: clacon_8c.html

package info (click to toggle)
superlu 5.3.0%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 11,976 kB
  • sloc: ansic: 59,420; makefile: 405; fortran: 185; csh: 141
file content (173 lines) | stat: -rw-r--r-- 8,457 bytes parent folder | download | duplicates (6)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>SuperLU: SRC/clacon.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 style="padding-left: 0.5em;">
   <div id="projectname">SuperLU
   &#160;<span id="projectnumber">5.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </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">clacon.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Estimates the 1-norm.  
<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__Cnames_8h_source.html">slu_Cnames.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="slu__scomplex_8h_source.html">slu_scomplex.h</a>&quot;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for clacon.c:</div>
<div class="dyncontent">
<div class="center"><img src="clacon_8c__incl.png" border="0" usemap="#SRC_2clacon_8c" alt=""/></div>
<map name="SRC_2clacon_8c" id="SRC_2clacon_8c">
<area shape="rect" id="node3" href="slu__Cnames_8h.html" title="Macros defining how C routines will be called. " alt="" coords="92,80,199,107"/><area shape="rect" id="node4" href="slu__scomplex_8h.html" title="Header file for complex operations. " alt="" coords="223,80,336,107"/></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:af4536a78f0ee7097ef59278c8cf14295"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clacon_8c.html#af4536a78f0ee7097ef59278c8cf14295">clacon_</a> (int *n, <a class="el" href="structcomplex.html">complex</a> *v, <a class="el" href="structcomplex.html">complex</a> *x, float *est, int *kase)</td></tr>
<tr class="separator:af4536a78f0ee7097ef59278c8cf14295"><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>
&ndash; SuperLU routine (version 2.0) &ndash;
Univ. of California Berkeley, Xerox Palo Alto Research Center,
and Lawrence Berkeley National Lab.
November 15, 1997
</pre> </div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="af4536a78f0ee7097ef59278c8cf14295"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int clacon_ </td>
          <td>(</td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcomplex.html">complex</a> *&#160;</td>
          <td class="paramname"><em>v</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcomplex.html">complex</a> *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>est</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>kase</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre>
<h1>Purpose   
</h1>
</pre><pre></pre><pre>  CLACON estimates the 1-norm of a square matrix A.   
  Reverse communication is used for evaluating matrix-vector products.</pre><pre><h1>Arguments   
</h1>
</pre><pre></pre><pre>  N      (input) INT
         The order of the matrix.  N &gt;= 1.</pre><pre>  V      (workspace) COMPLEX PRECISION array, dimension (N)   
         On the final return, V = A*W,  where  EST = norm(V)/norm(W)   
         (W is not returned).</pre><pre>  X      (input/output) COMPLEX PRECISION array, dimension (N)   
         On an intermediate return, X should be overwritten by   
               A * X,   if KASE=1,   
               A' * X,  if KASE=2,
         where A' is the conjugate transpose of A,
        and CLACON must be re-called with all the other parameters   
         unchanged.</pre><pre>  EST    (output) FLOAT PRECISION   
         An estimate (a lower bound) for norm(A).</pre><pre>  KASE   (input/output) INT
         On the initial call to CLACON, KASE should be 0.   
         On an intermediate return, KASE will be 1 or 2, indicating   
         whether X should be overwritten by A * X  or A' * X.   
         On the final return from CLACON, KASE will again be 0.</pre><pre>  Further Details   
  ======= =======</pre><pre>  Contributed by Nick Higham, University of Manchester.   
  Originally named CONEST, dated March 16, 1988.</pre><pre>  Reference: N.J. Higham, "FORTRAN codes for estimating the one-norm of 
  a real or complex matrix, with applications to condition estimation", 
</p>
<h1>ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.   
</h1>
</pre><pre>
</pre> 
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="clacon_8c_af4536a78f0ee7097ef59278c8cf14295_cgraph.png" border="0" usemap="#clacon_8c_af4536a78f0ee7097ef59278c8cf14295_cgraph" alt=""/></div>
<map name="clacon_8c_af4536a78f0ee7097ef59278c8cf14295_cgraph" id="clacon_8c_af4536a78f0ee7097ef59278c8cf14295_cgraph">
<area shape="rect" id="node2" href="icmax1_8c.html#a53b891600ab40c636f315c490c39749e" title="icmax1_slu" alt="" coords="123,5,211,32"/><area shape="rect" id="node3" href="scsum1_8c.html#a5d604b880c9214d7550424041c3850aa" title="scsum1_slu" alt="" coords="121,56,213,83"/><area shape="rect" id="node4" href="scomplex_8c.html#afc2967f7b71477625eb58de94a6e4c71" title="Returns sqrt(z.r^2 + z.i^2) " alt="" coords="262,81,319,108"/><area shape="rect" id="node5" href="ilu__ccopy__to__ucol_8c.html#adb60937f3436da2e6d66dc11af4317e6" title="ccopy_" alt="" coords="135,157,199,184"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 8 2016 18:40:06 for SuperLU by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>