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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
<!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::backend Namespace 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('namespaceviennacl_1_1backend.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="#namespaces">Namespaces</a> |
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">viennacl::backend Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Namespace providing routines for handling the different memory domains.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceviennacl_1_1backend_1_1cpu__ram"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1cpu__ram.html">cpu_ram</a></td></tr>
<tr class="memdesc:namespaceviennacl_1_1backend_1_1cpu__ram"><td class="mdescLeft"> </td><td class="mdescRight">Provides implementations for handling memory buffers in CPU RAM. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespaceviennacl_1_1backend_1_1cuda"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1cuda.html">cuda</a></td></tr>
<tr class="memdesc:namespaceviennacl_1_1backend_1_1cuda"><td class="mdescLeft"> </td><td class="mdescRight">Provides implementations for handling CUDA memory buffers. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespaceviennacl_1_1backend_1_1detail"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1detail.html">detail</a></td></tr>
<tr class="memdesc:namespaceviennacl_1_1backend_1_1detail"><td class="mdescLeft"> </td><td class="mdescRight">Implementation details for the generic memory backend interface. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespaceviennacl_1_1backend_1_1opencl"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1opencl.html">opencl</a></td></tr>
<tr class="memdesc:namespaceviennacl_1_1backend_1_1opencl"><td class="mdescLeft"> </td><td class="mdescRight">Provides implementations for handling OpenCL memory buffers. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Main abstraction class for multiple memory domains. Represents a buffer in either main RAM, an OpenCL context, or a CUDA device. <a href="classviennacl_1_1backend_1_1mem__handle.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1backend_1_1typesafe__host__array.html">typesafe_host_array</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Helper class implementing an array on the host. Default case: No conversion necessary. <a href="classviennacl_1_1backend_1_1typesafe__host__array.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classviennacl_1_1backend_1_1typesafe__host__array_3_01_t_00_01true_01_4.html">typesafe_host_array< T, true ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Special host array type for conversion between OpenCL types and pure CPU types. <a href="classviennacl_1_1backend_1_1typesafe__host__array_3_01_t_00_01true_01_4.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0238c5401fc7e05c3641b1ad5e872458"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceviennacl.html#a00b40450b6b2fd87aad3527d9b2084b8">memory_types</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a0238c5401fc7e05c3641b1ad5e872458">default_memory_type</a> ()</td></tr>
<tr class="memdesc:a0238c5401fc7e05c3641b1ad5e872458"><td class="mdescLeft"> </td><td class="mdescRight">Returns the default memory type for the given configuration. <a href="#a0238c5401fc7e05c3641b1ad5e872458">More...</a><br/></td></tr>
<tr class="separator:a0238c5401fc7e05c3641b1ad5e872458"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1361a53026515c9e7b7b57548c66a500"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceviennacl.html#a00b40450b6b2fd87aad3527d9b2084b8">memory_types</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a1361a53026515c9e7b7b57548c66a500">default_memory_type</a> (<a class="el" href="namespaceviennacl.html#a00b40450b6b2fd87aad3527d9b2084b8">memory_types</a> new_memory_type)</td></tr>
<tr class="memdesc:a1361a53026515c9e7b7b57548c66a500"><td class="mdescLeft"> </td><td class="mdescRight">Sets the default memory type for the given configuration. <a href="#a1361a53026515c9e7b7b57548c66a500">More...</a><br/></td></tr>
<tr class="separator:a1361a53026515c9e7b7b57548c66a500"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3707340b27c535438e213e3879b0f0a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a3707340b27c535438e213e3879b0f0a4">finish</a> ()</td></tr>
<tr class="memdesc:a3707340b27c535438e213e3879b0f0a4"><td class="mdescLeft"> </td><td class="mdescRight">Synchronizes the execution. <a class="el" href="namespaceviennacl_1_1backend.html#a3707340b27c535438e213e3879b0f0a4" title="Synchronizes the execution. finish() will only return after all compute kernels (CUDA, OpenCL) have completed. ">finish()</a> will only return after all compute kernels (CUDA, OpenCL) have completed. <a href="#a3707340b27c535438e213e3879b0f0a4">More...</a><br/></td></tr>
<tr class="separator:a3707340b27c535438e213e3879b0f0a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1499f19634964e2c7c8aeeefc6206126"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a1499f19634964e2c7c8aeeefc6206126">memory_create</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> &handle, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> size_in_bytes, <a class="el" href="classviennacl_1_1context.html">viennacl::context</a> const &ctx, const void *host_ptr=NULL)</td></tr>
<tr class="memdesc:a1499f19634964e2c7c8aeeefc6206126"><td class="mdescLeft"> </td><td class="mdescRight">Creates an array of the specified size. If the second argument is provided, the buffer is initialized with data from that pointer. <a href="#a1499f19634964e2c7c8aeeefc6206126">More...</a><br/></td></tr>
<tr class="separator:a1499f19634964e2c7c8aeeefc6206126"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39a91fd7aa68ebf64bd7bfa409732ec0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a39a91fd7aa68ebf64bd7bfa409732ec0">memory_copy</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> const &src_buffer, <a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> &dst_buffer, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> src_offset, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> dst_offset, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> bytes_to_copy)</td></tr>
<tr class="memdesc:a39a91fd7aa68ebf64bd7bfa409732ec0"><td class="mdescLeft"> </td><td class="mdescRight">Copies 'bytes_to_copy' bytes from address 'src_buffer + src_offset' to memory starting at address 'dst_buffer + dst_offset'. <a href="#a39a91fd7aa68ebf64bd7bfa409732ec0">More...</a><br/></td></tr>
<tr class="separator:a39a91fd7aa68ebf64bd7bfa409732ec0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8548a37535eac92e886cb183182b618f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a8548a37535eac92e886cb183182b618f">memory_shallow_copy</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> const &src_buffer, <a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> &dst_buffer)</td></tr>
<tr class="memdesc:a8548a37535eac92e886cb183182b618f"><td class="mdescLeft"> </td><td class="mdescRight">A 'shallow' copy operation from an initialized buffer to an uninitialized buffer. The uninitialized buffer just copies the raw handle. <a href="#a8548a37535eac92e886cb183182b618f">More...</a><br/></td></tr>
<tr class="separator:a8548a37535eac92e886cb183182b618f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06bdedb2bc72dc1922cada91e9bbbd61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a06bdedb2bc72dc1922cada91e9bbbd61">memory_write</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> &dst_buffer, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> dst_offset, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> bytes_to_write, const void *ptr, bool async=false)</td></tr>
<tr class="memdesc:a06bdedb2bc72dc1922cada91e9bbbd61"><td class="mdescLeft"> </td><td class="mdescRight">Writes data from main RAM identified by 'ptr' to the buffer identified by 'dst_buffer'. <a href="#a06bdedb2bc72dc1922cada91e9bbbd61">More...</a><br/></td></tr>
<tr class="separator:a06bdedb2bc72dc1922cada91e9bbbd61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62854cfd6f04404b274f8ede36f63e2d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a62854cfd6f04404b274f8ede36f63e2d">memory_read</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> const &src_buffer, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> src_offset, <a class="el" href="namespaceviennacl.html#a98a0afcc513111ffa0bd138f891930df">vcl_size_t</a> bytes_to_read, void *ptr, bool async=false)</td></tr>
<tr class="memdesc:a62854cfd6f04404b274f8ede36f63e2d"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from a buffer back to main RAM. <a href="#a62854cfd6f04404b274f8ede36f63e2d">More...</a><br/></td></tr>
<tr class="separator:a62854cfd6f04404b274f8ede36f63e2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a125b816cda53b54723572f319c096e68"><td class="memTemplParams" colspan="2">template<typename DataType > </td></tr>
<tr class="memitem:a125b816cda53b54723572f319c096e68"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a125b816cda53b54723572f319c096e68">switch_memory_context</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> &handle, <a class="el" href="classviennacl_1_1context.html">viennacl::context</a> new_ctx)</td></tr>
<tr class="memdesc:a125b816cda53b54723572f319c096e68"><td class="mdescLeft"> </td><td class="mdescRight">Switches the active memory domain within a memory handle. Data is copied if the new active domain differs from the old one. Memory in the source handle is not free'd. <a href="#a125b816cda53b54723572f319c096e68">More...</a><br/></td></tr>
<tr class="separator:a125b816cda53b54723572f319c096e68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e08136f371bfae415d35f75a7c8639d"><td class="memTemplParams" colspan="2">template<typename DataType > </td></tr>
<tr class="memitem:a3e08136f371bfae415d35f75a7c8639d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a3e08136f371bfae415d35f75a7c8639d">typesafe_memory_copy</a> (<a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> const &handle_src, <a class="el" href="classviennacl_1_1backend_1_1mem__handle.html">mem_handle</a> &handle_dst)</td></tr>
<tr class="memdesc:a3e08136f371bfae415d35f75a7c8639d"><td class="mdescLeft"> </td><td class="mdescRight">Copies data of the provided 'DataType' from 'handle_src' to 'handle_dst' and converts the data if the binary representation of 'DataType' among the memory domains differs. <a href="#a3e08136f371bfae415d35f75a7c8639d">More...</a><br/></td></tr>
<tr class="separator:a3e08136f371bfae415d35f75a7c8639d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Namespace providing routines for handling the different memory domains. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a0238c5401fc7e05c3641b1ad5e872458"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceviennacl.html#a00b40450b6b2fd87aad3527d9b2084b8">memory_types</a> viennacl::backend::default_memory_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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 default memory type for the given configuration. </p>
<p>CUDA has precedence over OpenCL, which has precedence over main memory. Depends on which VIENNACL_WITH_{CUDA/OPENCL/OPENMP} macros are defined. </p>
<p>Definition at line <a class="el" href="mem__handle_8hpp_source.html#l00073">73</a> of file <a class="el" href="mem__handle_8hpp_source.html">mem_handle.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1361a53026515c9e7b7b57548c66a500"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceviennacl.html#a00b40450b6b2fd87aad3527d9b2084b8">memory_types</a> viennacl::backend::default_memory_type </td>
<td>(</td>
<td class="paramtype">memory_types </td>
<td class="paramname"><em>new_memory_type</em></td><td>)</td>
<td></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>Sets the default memory type for the given configuration. </p>
<p>Make sure the respective new memory type is enabled. For example, passing CUDA_MEMORY if no CUDA backend is selected will result in exceptions being thrown as soon as you try to allocate buffers. </p>
<p>Definition at line <a class="el" href="mem__handle_8hpp_source.html#l00080">80</a> of file <a class="el" href="mem__handle_8hpp_source.html">mem_handle.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3707340b27c535438e213e3879b0f0a4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::finish </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Synchronizes the execution. <a class="el" href="namespaceviennacl_1_1backend.html#a3707340b27c535438e213e3879b0f0a4" title="Synchronizes the execution. finish() will only return after all compute kernels (CUDA, OpenCL) have completed. ">finish()</a> will only return after all compute kernels (CUDA, OpenCL) have completed. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="amg_8cpp-example.html#a4">amg.cpp</a>, and <a class="el" href="blas3_8cpp-example.html#a17">blas3.cpp</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00054">54</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a39a91fd7aa68ebf64bd7bfa409732ec0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::memory_copy </td>
<td>(</td>
<td class="paramtype">mem_handle const & </td>
<td class="paramname"><em>src_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mem_handle & </td>
<td class="paramname"><em>dst_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>src_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>dst_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>bytes_to_copy</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies 'bytes_to_copy' bytes from address 'src_buffer + src_offset' to memory starting at address 'dst_buffer + dst_offset'. </p>
<p>This is the generic version for CPU RAM, CUDA, and OpenCL. Copies the memory in the currently active memory domain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src_buffer</td><td>A smart pointer to the begin of an allocated buffer </td></tr>
<tr><td class="paramname">dst_buffer</td><td>A smart pointer to the end of an allocated buffer </td></tr>
<tr><td class="paramname">src_offset</td><td>Offset of the first byte to be written from the address given by 'src_buffer' (in bytes) </td></tr>
<tr><td class="paramname">dst_offset</td><td>Offset of the first byte to be written to the address given by 'dst_buffer' (in bytes) </td></tr>
<tr><td class="paramname">bytes_to_copy</td><td>Number of bytes to be copied </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00140">140</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1499f19634964e2c7c8aeeefc6206126"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::memory_create </td>
<td>(</td>
<td class="paramtype">mem_handle & </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>size_in_bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classviennacl_1_1context.html">viennacl::context</a> const & </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>host_ptr</em> = <code>NULL</code> </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an array of the specified size. If the second argument is provided, the buffer is initialized with data from that pointer. </p>
<p>This is the generic version for CPU RAM, CUDA, and OpenCL. Creates the memory in the currently active memory domain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The generic wrapper handle for multiple memory domains which will hold the new buffer. </td></tr>
<tr><td class="paramname">size_in_bytes</td><td>Number of bytes to allocate </td></tr>
<tr><td class="paramname">ctx</td><td>Optional context in which the matrix is created (one out of multiple OpenCL contexts, CUDA, host) </td></tr>
<tr><td class="paramname">host_ptr</td><td>Pointer to data which will be copied to the new array. Must point to at least 'size_in_bytes' bytes of data. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00087">87</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a62854cfd6f04404b274f8ede36f63e2d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::memory_read </td>
<td>(</td>
<td class="paramtype">mem_handle const & </td>
<td class="paramname"><em>src_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>src_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>bytes_to_read</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>async</em> = <code>false</code> </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads data from a buffer back to main RAM. </p>
<p>This is the generic version for CPU RAM, CUDA, and OpenCL. Reads the memory from the currently active memory domain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src_buffer</td><td>A smart pointer to the beginning of an allocated source buffer </td></tr>
<tr><td class="paramname">src_offset</td><td>Offset of the first byte to be read from the beginning of src_buffer (in bytes_ </td></tr>
<tr><td class="paramname">bytes_to_read</td><td>Number of bytes to be read </td></tr>
<tr><td class="paramname">ptr</td><td>Location in main RAM where to read data should be written to </td></tr>
<tr><td class="paramname">async</td><td>Whether the operation should be asynchronous </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00261">261</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8548a37535eac92e886cb183182b618f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::memory_shallow_copy </td>
<td>(</td>
<td class="paramtype">mem_handle const & </td>
<td class="paramname"><em>src_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mem_handle & </td>
<td class="paramname"><em>dst_buffer</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A 'shallow' copy operation from an initialized buffer to an uninitialized buffer. The uninitialized buffer just copies the raw handle. </p>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00177">177</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a06bdedb2bc72dc1922cada91e9bbbd61"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::memory_write </td>
<td>(</td>
<td class="paramtype">mem_handle & </td>
<td class="paramname"><em>dst_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>dst_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vcl_size_t </td>
<td class="paramname"><em>bytes_to_write</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>async</em> = <code>false</code> </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes data from main RAM identified by 'ptr' to the buffer identified by 'dst_buffer'. </p>
<p>This is the generic version for CPU RAM, CUDA, and OpenCL. Writes the memory in the currently active memory domain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst_buffer</td><td>A smart pointer to the beginning of an allocated buffer </td></tr>
<tr><td class="paramname">dst_offset</td><td>Offset of the first written byte from the beginning of 'dst_buffer' (in bytes) </td></tr>
<tr><td class="paramname">bytes_to_write</td><td>Number of bytes to be written </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to the first byte to be written </td></tr>
<tr><td class="paramname">async</td><td>Whether the operation should be asynchronous </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00220">220</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a125b816cda53b54723572f319c096e68"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename DataType > </div>
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::switch_memory_context </td>
<td>(</td>
<td class="paramtype">mem_handle & </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classviennacl_1_1context.html">viennacl::context</a> </td>
<td class="paramname"><em>new_ctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Switches the active memory domain within a memory handle. Data is copied if the new active domain differs from the old one. Memory in the source handle is not free'd. </p>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00368">368</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3e08136f371bfae415d35f75a7c8639d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename DataType > </div>
<table class="memname">
<tr>
<td class="memname">void viennacl::backend::typesafe_memory_copy </td>
<td>(</td>
<td class="paramtype">mem_handle const & </td>
<td class="paramname"><em>handle_src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mem_handle & </td>
<td class="paramname"><em>handle_dst</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies data of the provided 'DataType' from 'handle_src' to 'handle_dst' and converts the data if the binary representation of 'DataType' among the memory domains differs. </p>
<p>Definition at line <a class="el" href="memory_8hpp_source.html#l00470">470</a> of file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</div>
</div>
</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="namespaceviennacl_1_1backend.html">backend</a></li>
<li class="footer">Generated on Wed Jan 20 2016 22:32:45 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>
|
