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
|
<!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>ViennaCL - The Vienna Computing Library: viennacl/linalg/jacobi_precond.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">ViennaCL - The Vienna Computing Library
 <span id="projectnumber">1.7.1</span>
</div>
<div id="projectbrief">Free open-source GPU-accelerated linear algebra and solver library.</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('jacobi__precond_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">jacobi_precond.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="jacobi__precond_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef VIENNACL_LINALG_JACOBI_PRECOND_HPP_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define VIENNACL_LINALG_JACOBI_PRECOND_HPP_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* =========================================================================</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> Copyright (c) 2010-2016, Institute for Microelectronics,</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Institute for Analysis and Scientific Computing,</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> TU Wien.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Portions of this software are copyright by UChicago Argonne, LLC.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> -----------------</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ViennaCL - The Vienna Computing Library</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> -----------------</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Project Head: Karl Rupp rupp@iue.tuwien.ac.at</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> (A list of authors and contributors can be found in the manual)</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> License: MIT (X11), see file LICENSE in the base directory</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">============================================================================= */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <cmath></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="forwards_8h.html">viennacl/forwards.h</a>"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="vector_8hpp.html">viennacl/vector.hpp</a>"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="compressed__matrix_8hpp.html">viennacl/compressed_matrix.hpp</a>"</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="tools_8hpp.html">viennacl/tools/tools.hpp</a>"</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="sparse__matrix__operations_8hpp.html">viennacl/linalg/sparse_matrix_operations.hpp</a>"</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="row__scaling_8hpp.html">viennacl/linalg/row_scaling.hpp</a>"</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <map></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>viennacl</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span>linalg</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__tag.html"> 43</a></span> <span class="keyword">class </span><a class="code" href="classviennacl_1_1linalg_1_1jacobi__tag.html">jacobi_tag</a> {};</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">template</span><<span class="keyword">typename</span> MatrixT,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span> <a class="code" href="structviennacl_1_1is__viennacl.html">is_viennacl</a> = detail::row_scaling_for_viennacl<MatrixT>::value ></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html">jacobi_precond</a></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> MatrixT::value_type NumericType;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a8484f42e58dc181682e8b0d7c5e59c2a"> 55</a></span>  <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a8484f42e58dc181682e8b0d7c5e59c2a">jacobi_precond</a>(MatrixT <span class="keyword">const</span> & mat, <a class="code" href="classviennacl_1_1linalg_1_1jacobi__tag.html">jacobi_tag</a> <span class="keyword">const</span> &) : diag_A_(viennacl::traits::<a class="code" href="namespaceviennacl_1_1traits.html#aa756f5d6820722094cae0d8b9bb6d5e2">size1</a>(mat))</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a4dc33d4e561b2f29bd37131a1c015622">init</a>(mat);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a4dc33d4e561b2f29bd37131a1c015622"> 60</a></span>  <span class="keywordtype">void</span> <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a4dc33d4e561b2f29bd37131a1c015622">init</a>(MatrixT <span class="keyword">const</span> & mat)</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  diag_A_.resize(<a class="code" href="namespaceviennacl_1_1traits.html#aa756f5d6820722094cae0d8b9bb6d5e2">viennacl::traits::size1</a>(mat)); <span class="comment">//resize without preserving values</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">for</span> (<span class="keyword">typename</span> MatrixT::const_iterator1 row_it = mat.begin1();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  row_it != mat.end1();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  ++row_it)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> diag_found = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">for</span> (<span class="keyword">typename</span> MatrixT::const_iterator2 col_it = row_it.begin();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  col_it != row_it.end();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  ++col_it)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">if</span> (col_it.index1() == col_it.index2())</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  diag_A_[col_it.index1()] = *col_it;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  diag_found = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">if</span> (!diag_found)</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">throw</span> <a class="code" href="classviennacl_1_1zero__on__diagonal__exception.html">zero_on_diagonal_exception</a>(<span class="stringliteral">"ViennaCL: Zero in diagonal encountered while setting up Jacobi preconditioner!"</span>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">template</span><<span class="keyword">typename</span> VectorT></div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a5d3e48bbec7300c929d58e445455f4dc"> 87</a></span>  <span class="keywordtype">void</span> <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a5d3e48bbec7300c929d58e445455f4dc">apply</a>(VectorT & vec)<span class="keyword"> const</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  assert(<a class="code" href="namespaceviennacl_1_1traits.html#aa2344ea20469f55fbc15a8e9526494d0">viennacl::traits::size</a>(diag_A_) == <a class="code" href="namespaceviennacl_1_1traits.html#aa2344ea20469f55fbc15a8e9526494d0">viennacl::traits::size</a>(vec) && <span class="keywordtype">bool</span>(<span class="stringliteral">"Size mismatch"</span>));</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">for</span> (<a class="code" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> i=0; i<diag_A_.size(); ++i)</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  vec[i] /= diag_A_[i];</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::vector<NumericType> diag_A_;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> };</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">template</span><<span class="keyword">typename</span> MatrixT></div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html"> 104</a></span> <span class="keyword">class </span><a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html">jacobi_precond</a><MatrixT, true></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="structviennacl_1_1result__of_1_1cpu__value__type.html#aa015d93f419985879a7c13b09633c5c6">viennacl::result_of::cpu_value_type<typename MatrixT::value_type>::type</a> NumericType;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#ac157dcfa0588c12f721fd1f0b492d222"> 109</a></span>  <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#ac157dcfa0588c12f721fd1f0b492d222">jacobi_precond</a>(MatrixT <span class="keyword">const</span> & mat, <a class="code" href="classviennacl_1_1linalg_1_1jacobi__tag.html">jacobi_tag</a> <span class="keyword">const</span> &) : diag_A_(mat.<a class="code" href="namespaceviennacl_1_1traits.html#aa756f5d6820722094cae0d8b9bb6d5e2">size1</a>(), viennacl::traits::<a class="code" href="classviennacl_1_1context.html">context</a>(mat))</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond.html#a4dc33d4e561b2f29bd37131a1c015622">init</a>(mat);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  }</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#a3093b690a945ff6cd760ea3d185383f4"> 115</a></span>  <span class="keywordtype">void</span> <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#a3093b690a945ff6cd760ea3d185383f4">init</a>(MatrixT <span class="keyword">const</span> & mat)</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="namespaceviennacl_1_1linalg_1_1detail.html#a5ef8943054b39077573f94234980bd0f">detail::row_info</a>(mat, diag_A_, <a class="code" href="namespaceviennacl_1_1linalg_1_1detail.html#adc2e9ed3e4d9fb0258840837aaa722aca0750e54730307e2c1d1b6bfaabc7a1dd">detail::SPARSE_ROW_DIAGONAL</a>);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">template</span><<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> AlignmentV></div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#a02ba836483f54534222e2d161f5565fe"> 122</a></span>  <span class="keywordtype">void</span> <a class="code" href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#a02ba836483f54534222e2d161f5565fe">apply</a>(<a class="code" href="classviennacl_1_1vector.html">viennacl::vector<NumericType, AlignmentV></a> & vec)<span class="keyword"> const</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  assert(<a class="code" href="namespaceviennacl_1_1traits.html#aa2344ea20469f55fbc15a8e9526494d0">viennacl::traits::size</a>(diag_A_) == <a class="code" href="namespaceviennacl_1_1traits.html#aa2344ea20469f55fbc15a8e9526494d0">viennacl::traits::size</a>(vec) && <span class="keywordtype">bool</span>(<span class="stringliteral">"Size mismatch"</span>));</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  vec = <a class="code" href="namespaceviennacl_1_1linalg.html#a3207a7759c34cfe4e961aabadd616a13">element_div</a>(vec, diag_A_);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classviennacl_1_1vector.html">viennacl::vector<NumericType></a> diag_A_;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> };</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> }</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="ttc" id="namespaceviennacl_1_1linalg_html_a3207a7759c34cfe4e961aabadd616a13"><div class="ttname"><a href="namespaceviennacl_1_1linalg.html#a3207a7759c34cfe4e961aabadd616a13">viennacl::linalg::element_div</a></div><div class="ttdeci">viennacl::vector_expression< const vector_base< T >, const vector_base< T >, op_element_binary< op_div > > element_div(vector_base< T > const &v1, vector_base< T > const &v2)</div></div>
<div class="ttc" id="classviennacl_1_1zero__on__diagonal__exception_html"><div class="ttname"><a href="classviennacl_1_1zero__on__diagonal__exception.html">viennacl::zero_on_diagonal_exception</a></div><div class="ttdef"><b>Definition:</b> <a href="forwards_8h_source.html#l00597">forwards.h:597</a></div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_html"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond.html">viennacl::linalg::jacobi_precond</a></div><div class="ttdoc">Jacobi preconditioner class, can be supplied to solve()-routines. Generic version for non-ViennaCL ma...</div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00050">jacobi_precond.hpp:50</a></div></div>
<div class="ttc" id="tools_8hpp_html"><div class="ttname"><a href="tools_8hpp.html">tools.hpp</a></div><div class="ttdoc">Various little tools used here and there in ViennaCL. </div></div>
<div class="ttc" id="namespaceviennacl_1_1traits_html_aa756f5d6820722094cae0d8b9bb6d5e2"><div class="ttname"><a href="namespaceviennacl_1_1traits.html#aa756f5d6820722094cae0d8b9bb6d5e2">viennacl::traits::size1</a></div><div class="ttdeci">vcl_size_t size1(MatrixType const &mat)</div><div class="ttdoc">Generic routine for obtaining the number of rows of a matrix (ViennaCL, uBLAS, etc.) </div><div class="ttdef"><b>Definition:</b> <a href="size_8hpp_source.html#l00163">size.hpp:163</a></div></div>
<div class="ttc" id="forwards_8h_html"><div class="ttname"><a href="forwards_8h.html">forwards.h</a></div><div class="ttdoc">This file provides the forward declarations for the main types used within ViennaCL. </div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__tag_html"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__tag.html">viennacl::linalg::jacobi_tag</a></div><div class="ttdoc">A tag for a jacobi preconditioner. </div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00043">jacobi_precond.hpp:43</a></div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4_html_a02ba836483f54534222e2d161f5565fe"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#a02ba836483f54534222e2d161f5565fe">viennacl::linalg::jacobi_precond< MatrixT, true >::apply</a></div><div class="ttdeci">void apply(viennacl::vector< NumericType, AlignmentV > &vec) const </div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00122">jacobi_precond.hpp:122</a></div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_html_a4dc33d4e561b2f29bd37131a1c015622"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond.html#a4dc33d4e561b2f29bd37131a1c015622">viennacl::linalg::jacobi_precond::init</a></div><div class="ttdeci">void init(MatrixT const &mat)</div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00060">jacobi_precond.hpp:60</a></div></div>
<div class="ttc" id="classviennacl_1_1context_html"><div class="ttname"><a href="classviennacl_1_1context.html">viennacl::context</a></div><div class="ttdoc">Represents a generic 'context' similar to an OpenCL context, but is backend-agnostic and thus also su...</div><div class="ttdef"><b>Definition:</b> <a href="context_8hpp_source.html#l00039">context.hpp:39</a></div></div>
<div class="ttc" id="structviennacl_1_1is__viennacl_html"><div class="ttname"><a href="structviennacl_1_1is__viennacl.html">viennacl::is_viennacl</a></div><div class="ttdoc">Meta function which checks whether a tag is tag_viennacl. </div><div class="ttdef"><b>Definition:</b> <a href="tag__of_8hpp_source.html#l00375">tag_of.hpp:375</a></div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4_html_a3093b690a945ff6cd760ea3d185383f4"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#a3093b690a945ff6cd760ea3d185383f4">viennacl::linalg::jacobi_precond< MatrixT, true >::init</a></div><div class="ttdeci">void init(MatrixT const &mat)</div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00115">jacobi_precond.hpp:115</a></div></div>
<div class="ttc" id="namespaceviennacl_1_1traits_html_aa2344ea20469f55fbc15a8e9526494d0"><div class="ttname"><a href="namespaceviennacl_1_1traits.html#aa2344ea20469f55fbc15a8e9526494d0">viennacl::traits::size</a></div><div class="ttdeci">vcl_size_t size(VectorType const &vec)</div><div class="ttdoc">Generic routine for obtaining the size of a vector (ViennaCL, uBLAS, etc.) </div><div class="ttdef"><b>Definition:</b> <a href="size_8hpp_source.html#l00239">size.hpp:239</a></div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_html_a8484f42e58dc181682e8b0d7c5e59c2a"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond.html#a8484f42e58dc181682e8b0d7c5e59c2a">viennacl::linalg::jacobi_precond::jacobi_precond</a></div><div class="ttdeci">jacobi_precond(MatrixT const &mat, jacobi_tag const &)</div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00055">jacobi_precond.hpp:55</a></div></div>
<div class="ttc" id="compressed__matrix_8hpp_html"><div class="ttname"><a href="compressed__matrix_8hpp.html">compressed_matrix.hpp</a></div><div class="ttdoc">Implementation of the compressed_matrix class. </div></div>
<div class="ttc" id="sparse__matrix__operations_8hpp_html"><div class="ttname"><a href="sparse__matrix__operations_8hpp.html">sparse_matrix_operations.hpp</a></div><div class="ttdoc">Implementations of operations using sparse matrices. </div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_html_a5d3e48bbec7300c929d58e445455f4dc"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond.html#a5d3e48bbec7300c929d58e445455f4dc">viennacl::linalg::jacobi_precond::apply</a></div><div class="ttdeci">void apply(VectorT &vec) const </div><div class="ttdoc">Apply to res = b - Ax, i.e. jacobi applied vec (right hand side),. </div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00087">jacobi_precond.hpp:87</a></div></div>
<div class="ttc" id="namespaceviennacl_html_a98a0afcc513111ffa0bd138f891930df"><div class="ttname"><a href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">viennacl::vcl_size_t</a></div><div class="ttdeci">std::size_t vcl_size_t</div><div class="ttdef"><b>Definition:</b> <a href="forwards_8h_source.html#l00075">forwards.h:75</a></div></div>
<div class="ttc" id="classviennacl_1_1vector_html"><div class="ttname"><a href="classviennacl_1_1vector.html">viennacl::vector</a></div><div class="ttdef"><b>Definition:</b> <a href="forwards_8h_source.html#l00266">forwards.h:266</a></div></div>
<div class="ttc" id="structviennacl_1_1result__of_1_1cpu__value__type_html_aa015d93f419985879a7c13b09633c5c6"><div class="ttname"><a href="structviennacl_1_1result__of_1_1cpu__value__type.html#aa015d93f419985879a7c13b09633c5c6">viennacl::result_of::cpu_value_type::type</a></div><div class="ttdeci">T::ERROR_CANNOT_DEDUCE_CPU_SCALAR_TYPE_FOR_T type</div><div class="ttdef"><b>Definition:</b> <a href="result__of_8hpp_source.html#l00271">result_of.hpp:271</a></div></div>
<div class="ttc" id="row__scaling_8hpp_html"><div class="ttname"><a href="row__scaling_8hpp.html">row_scaling.hpp</a></div><div class="ttdoc">A row normalization preconditioner is implemented here. </div></div>
<div class="ttc" id="vector_8hpp_html"><div class="ttname"><a href="vector_8hpp.html">vector.hpp</a></div><div class="ttdoc">The vector type with operator-overloads and proxy classes is defined here. Linear algebra operations ...</div></div>
<div class="ttc" id="namespaceviennacl_1_1linalg_1_1detail_html_adc2e9ed3e4d9fb0258840837aaa722aca0750e54730307e2c1d1b6bfaabc7a1dd"><div class="ttname"><a href="namespaceviennacl_1_1linalg_1_1detail.html#adc2e9ed3e4d9fb0258840837aaa722aca0750e54730307e2c1d1b6bfaabc7a1dd">viennacl::linalg::detail::SPARSE_ROW_DIAGONAL</a></div><div class="ttdef"><b>Definition:</b> <a href="forwards_8h_source.html#l00842">forwards.h:842</a></div></div>
<div class="ttc" id="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4_html_ac157dcfa0588c12f721fd1f0b492d222"><div class="ttname"><a href="classviennacl_1_1linalg_1_1jacobi__precond_3_01_matrix_t_00_01true_01_4.html#ac157dcfa0588c12f721fd1f0b492d222">viennacl::linalg::jacobi_precond< MatrixT, true >::jacobi_precond</a></div><div class="ttdeci">jacobi_precond(MatrixT const &mat, jacobi_tag const &)</div><div class="ttdef"><b>Definition:</b> <a href="jacobi__precond_8hpp_source.html#l00109">jacobi_precond.hpp:109</a></div></div>
<div class="ttc" id="namespaceviennacl_1_1linalg_1_1detail_html_a5ef8943054b39077573f94234980bd0f"><div class="ttname"><a href="namespaceviennacl_1_1linalg_1_1detail.html#a5ef8943054b39077573f94234980bd0f">viennacl::linalg::detail::row_info</a></div><div class="ttdeci">viennacl::enable_if< viennacl::is_any_sparse_matrix< SparseMatrixType >::value >::type row_info(SparseMatrixType const &mat, vector< SCALARTYPE, VEC_ALIGNMENT > &vec, row_info_types info_selector)</div><div class="ttdef"><b>Definition:</b> <a href="sparse__matrix__operations_8hpp_source.html#l00050">sparse_matrix_operations.hpp:50</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_c82e3d11dd171600f4a6e0cab1ec1e0d.html">viennacl</a></li><li class="navelem"><a class="el" href="dir_63cde087767c4ed65c7901ffc6e293fe.html">linalg</a></li><li class="navelem"><a class="el" href="jacobi__precond_8hpp.html">jacobi_precond.hpp</a></li>
<li class="footer">Generated on Wed Jan 20 2016 22:32:42 for ViennaCL - The Vienna Computing Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
|
