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
|
<!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::const_entry_proxy< SCALARTYPE > Class Template 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="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('classviennacl_1_1const__entry__proxy.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="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classviennacl_1_1const__entry__proxy-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">viennacl::const_entry_proxy< SCALARTYPE > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A proxy class for a single element of a vector or matrix. This proxy should not be noticed by end-users of the library.
<a href="classviennacl_1_1const__entry__proxy.html#details">More...</a></p>
<p><code>#include <<a class="el" href="forwards_8h_source.html">forwards.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8f916f229ef166b16006b514b13d1318"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">viennacl::backend::mem_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1const__entry__proxy.html#a8f916f229ef166b16006b514b13d1318">handle_type</a></td></tr>
<tr class="separator:a8f916f229ef166b16006b514b13d1318"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9906f1d945b78b11ab14feef6367d2c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1const__entry__proxy.html#a9906f1d945b78b11ab14feef6367d2c8">const_entry_proxy</a> (<a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> mem_offset, <a class="el" href="classviennacl_1_1const__entry__proxy.html#a8f916f229ef166b16006b514b13d1318">handle_type</a> const &mem_handle)</td></tr>
<tr class="memdesc:a9906f1d945b78b11ab14feef6367d2c8"><td class="mdescLeft"> </td><td class="mdescRight">The constructor for the proxy class. Declared explicit to avoid any surprises created by the compiler. <a href="#a9906f1d945b78b11ab14feef6367d2c8">More...</a><br/></td></tr>
<tr class="separator:a9906f1d945b78b11ab14feef6367d2c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc1b268a517bbb435434b9bf54f2313a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1const__entry__proxy.html#abc1b268a517bbb435434b9bf54f2313a">operator NumericT</a> () const </td></tr>
<tr class="memdesc:abc1b268a517bbb435434b9bf54f2313a"><td class="mdescLeft"> </td><td class="mdescRight">Conversion to a CPU floating point value. <a href="#abc1b268a517bbb435434b9bf54f2313a">More...</a><br/></td></tr>
<tr class="separator:abc1b268a517bbb435434b9bf54f2313a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac364f96496deec7473be1126f12279fc"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1const__entry__proxy.html#ac364f96496deec7473be1126f12279fc">index</a> () const </td></tr>
<tr class="memdesc:ac364f96496deec7473be1126f12279fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the represented element. <a href="#ac364f96496deec7473be1126f12279fc">More...</a><br/></td></tr>
<tr class="separator:ac364f96496deec7473be1126f12279fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd3d3e90596401bb6cb6309cb6d46fb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classviennacl_1_1const__entry__proxy.html#a8f916f229ef166b16006b514b13d1318">handle_type</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1const__entry__proxy.html#afd3d3e90596401bb6cb6309cb6d46fb4">handle</a> () const </td></tr>
<tr class="memdesc:afd3d3e90596401bb6cb6309cb6d46fb4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the memory handle. <a href="#afd3d3e90596401bb6cb6309cb6d46fb4">More...</a><br/></td></tr>
<tr class="separator:afd3d3e90596401bb6cb6309cb6d46fb4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename SCALARTYPE><br/>
class viennacl::const_entry_proxy< SCALARTYPE ></h3>
<p>A proxy class for a single element of a vector or matrix. This proxy should not be noticed by end-users of the library. </p>
<p>This proxy provides access to a single entry of a vector. If the element is assigned to a GPU object, no unnecessary transfers to the CPU and back to GPU are initiated.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">NumericT</td><td>Either float or double </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="forwards_8h_source.html#l00236">236</a> of file <a class="el" href="forwards_8h_source.html">forwards.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a8f916f229ef166b16006b514b13d1318"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename SCALARTYPE> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">viennacl::backend::mem_handle</a> <a class="el" href="classviennacl_1_1const__entry__proxy.html">viennacl::const_entry_proxy</a>< SCALARTYPE >::<a class="el" href="classviennacl_1_1const__entry__proxy.html#a8f916f229ef166b16006b514b13d1318">handle_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="entry__proxy_8hpp_source.html#l00183">183</a> of file <a class="el" href="entry__proxy_8hpp_source.html">entry_proxy.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9906f1d945b78b11ab14feef6367d2c8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename SCALARTYPE> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classviennacl_1_1const__entry__proxy.html">viennacl::const_entry_proxy</a>< SCALARTYPE >::<a class="el" href="classviennacl_1_1const__entry__proxy.html">const_entry_proxy</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> </td>
<td class="paramname"><em>mem_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classviennacl_1_1const__entry__proxy.html#a8f916f229ef166b16006b514b13d1318">handle_type</a> const & </td>
<td class="paramname"><em>mem_handle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The constructor for the proxy class. Declared explicit to avoid any surprises created by the compiler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mem_offset</td><td>The memory offset in multiples of sizeof(NumericT) relative to the memory pointed to by the handle </td></tr>
<tr><td class="paramname">mem_handle</td><td>A <a class="el" href="classviennacl_1_1ocl_1_1handle.html" title="Handle class the effectively represents a smart pointer for OpenCL handles. ">viennacl::ocl::handle</a> for the memory buffer on the GPU. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="entry__proxy_8hpp_source.html#l00190">190</a> of file <a class="el" href="entry__proxy_8hpp_source.html">entry_proxy.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afd3d3e90596401bb6cb6309cb6d46fb4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename SCALARTYPE> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classviennacl_1_1const__entry__proxy.html#a8f916f229ef166b16006b514b13d1318">handle_type</a> const& <a class="el" href="classviennacl_1_1const__entry__proxy.html">viennacl::const_entry_proxy</a>< SCALARTYPE >::handle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the memory handle. </p>
<p>Definition at line <a class="el" href="entry__proxy_8hpp_source.html#l00216">216</a> of file <a class="el" href="entry__proxy_8hpp_source.html">entry_proxy.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac364f96496deec7473be1126f12279fc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename SCALARTYPE> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="classviennacl_1_1const__entry__proxy.html">viennacl::const_entry_proxy</a>< SCALARTYPE >::index </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the index of the represented element. </p>
<p>Definition at line <a class="el" href="entry__proxy_8hpp_source.html#l00212">212</a> of file <a class="el" href="entry__proxy_8hpp_source.html">entry_proxy.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="abc1b268a517bbb435434b9bf54f2313a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename SCALARTYPE> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classviennacl_1_1const__entry__proxy.html">viennacl::const_entry_proxy</a>< SCALARTYPE >::operator <a class="el" href="tests_2src_2bisect_8cpp.html#a52b5d30a2d7b064678644a3bf49b7f6c">NumericT</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Conversion to a CPU floating point value. </p>
<p>This conversion allows to write something like double test = vector(4); However, one has to keep in mind that CPU<->GPU transfers are very slow compared to CPU<->CPU operations. </p>
<p>Definition at line <a class="el" href="entry__proxy_8hpp_source.html#l00204">204</a> of file <a class="el" href="entry__proxy_8hpp_source.html">entry_proxy.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>viennacl/<a class="el" href="forwards_8h_source.html">forwards.h</a></li>
<li>viennacl/tools/<a class="el" href="entry__proxy_8hpp_source.html">entry_proxy.hpp</a></li>
</ul>
</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="namespaceviennacl.html">viennacl</a></li><li class="navelem"><a class="el" href="classviennacl_1_1const__entry__proxy.html">const_entry_proxy</a></li>
<li class="footer">Generated on Wed Jan 20 2016 22:32:44 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>
|
