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
|
<!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/memory.hpp 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="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('memory_8hpp.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">memory.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Main interface routines for memory management.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <vector></code><br/>
<code>#include <cassert></code><br/>
<code>#include "<a class="el" href="forwards_8h_source.html">viennacl/forwards.h</a>"</code><br/>
<code>#include "<a class="el" href="mem__handle_8hpp_source.html">viennacl/backend/mem_handle.hpp</a>"</code><br/>
<code>#include "<a class="el" href="context_8hpp_source.html">viennacl/context.hpp</a>"</code><br/>
<code>#include "<a class="el" href="traits_2handle_8hpp_source.html">viennacl/traits/handle.hpp</a>"</code><br/>
<code>#include "<a class="el" href="traits_2context_8hpp_source.html">viennacl/traits/context.hpp</a>"</code><br/>
<code>#include "<a class="el" href="backend_2util_8hpp_source.html">viennacl/backend/util.hpp</a>"</code><br/>
<code>#include "<a class="el" href="cpu__ram_8hpp_source.html">viennacl/backend/cpu_ram.hpp</a>"</code><br/>
</div>
<p><a href="memory_8hpp_source.html">Go to the source code of this file.</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"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl.html">viennacl</a></td></tr>
<tr class="memdesc:namespaceviennacl"><td class="mdescLeft"> </td><td class="mdescRight">Main namespace in ViennaCL. Holds all the basic types such as vector, matrix, etc. and defines operations upon them. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespaceviennacl_1_1backend"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html">viennacl::backend</a></td></tr>
<tr class="memdesc:namespaceviennacl_1_1backend"><td class="mdescLeft"> </td><td class="mdescRight">Namespace providing routines for handling the different memory domains. <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">viennacl::backend::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>
</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:a3707340b27c535438e213e3879b0f0a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend.html#a3707340b27c535438e213e3879b0f0a4">viennacl::backend::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">viennacl::backend::memory_create</a> (mem_handle &handle, vcl_size_t 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">viennacl::backend::memory_copy</a> (mem_handle const &src_buffer, mem_handle &dst_buffer, vcl_size_t src_offset, vcl_size_t dst_offset, vcl_size_t 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">viennacl::backend::memory_shallow_copy</a> (mem_handle const &src_buffer, mem_handle &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">viennacl::backend::memory_write</a> (mem_handle &dst_buffer, vcl_size_t dst_offset, vcl_size_t 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">viennacl::backend::memory_read</a> (mem_handle const &src_buffer, vcl_size_t src_offset, vcl_size_t 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:af9f9cc6c50debc5b1d93e458d1fd392a"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:af9f9cc6c50debc5b1d93e458d1fd392a"><td class="memTemplItemLeft" align="right" valign="top">vcl_size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1detail.html#af9f9cc6c50debc5b1d93e458d1fd392a">viennacl::backend::detail::element_size</a> (memory_types)</td></tr>
<tr class="separator:af9f9cc6c50debc5b1d93e458d1fd392a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa26c168242b4a7522b3a44db4f35d678"><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr class="memitem:aa26c168242b4a7522b3a44db4f35d678"><td class="memTemplItemLeft" align="right" valign="top">vcl_size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1detail.html#aa26c168242b4a7522b3a44db4f35d678">viennacl::backend::detail::element_size< unsigned long ></a> (memory_types)</td></tr>
<tr class="separator:aa26c168242b4a7522b3a44db4f35d678"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06e699859e0bf8a0dae58fa9814abf45"><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr class="memitem:a06e699859e0bf8a0dae58fa9814abf45"><td class="memTemplItemLeft" align="right" valign="top">vcl_size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1detail.html#a06e699859e0bf8a0dae58fa9814abf45">viennacl::backend::detail::element_size< long ></a> (memory_types)</td></tr>
<tr class="separator:a06e699859e0bf8a0dae58fa9814abf45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37a80732ade332cb8b1c0a17ed181b54"><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr class="memitem:a37a80732ade332cb8b1c0a17ed181b54"><td class="memTemplItemLeft" align="right" valign="top">vcl_size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1detail.html#a37a80732ade332cb8b1c0a17ed181b54">viennacl::backend::detail::element_size< unsigned int ></a> (memory_types)</td></tr>
<tr class="separator:a37a80732ade332cb8b1c0a17ed181b54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84e78df5ffd86afde0313ac849b0909a"><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr class="memitem:a84e78df5ffd86afde0313ac849b0909a"><td class="memTemplItemLeft" align="right" valign="top">vcl_size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl_1_1backend_1_1detail.html#a84e78df5ffd86afde0313ac849b0909a">viennacl::backend::detail::element_size< int ></a> (memory_types)</td></tr>
<tr class="separator:a84e78df5ffd86afde0313ac849b0909a"><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">viennacl::backend::switch_memory_context</a> (mem_handle &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">viennacl::backend::typesafe_memory_copy</a> (mem_handle const &handle_src, mem_handle &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>
<tr class="memitem:a87d41d517b3d0daca8b1536e15e6659d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a87d41d517b3d0daca8b1536e15e6659d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceviennacl.html#a87d41d517b3d0daca8b1536e15e6659d">viennacl::switch_memory_context</a> (T &obj, <a class="el" href="classviennacl_1_1context.html">viennacl::context</a> new_ctx)</td></tr>
<tr class="memdesc:a87d41d517b3d0daca8b1536e15e6659d"><td class="mdescLeft"> </td><td class="mdescRight">Generic convenience routine for migrating data of an object to a new memory domain. <a href="#a87d41d517b3d0daca8b1536e15e6659d">More...</a><br/></td></tr>
<tr class="separator:a87d41d517b3d0daca8b1536e15e6659d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Main interface routines for memory management. </p>
<p>Definition in file <a class="el" href="memory_8hpp_source.html">memory.hpp</a>.</p>
</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="dir_c82e3d11dd171600f4a6e0cab1ec1e0d.html">viennacl</a></li><li class="navelem"><a class="el" href="dir_225062f072d8eb572e25b876c44903f8.html">backend</a></li><li class="navelem"><a class="el" href="memory_8hpp.html">memory.hpp</a></li>
<li class="footer">Generated on Wed Jan 20 2016 22:32:43 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>
|
