-
Notifications
You must be signed in to change notification settings - Fork 0
/
classrr_1_1_cuda_backend.html
322 lines (300 loc) · 19 KB
/
classrr_1_1_cuda_backend.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libcudaisp: rr::CudaBackend Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libcudaisp
 <span id="projectnumber">0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacerr.html">rr</a></li><li class="navelem"><a class="el" href="classrr_1_1_cuda_backend.html">CudaBackend</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classrr_1_1_cuda_backend-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rr::CudaBackend Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This interface class manages the creation of CUDA Algorithms and CUDA Buffers.
<a href="classrr_1_1_cuda_backend.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cudabackend_8hpp_source.html">cudabackend.hpp</a>></code></p>
<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:ae19e277a3ee6b872d386dd290f29e48d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_backend.html#ae19e277a3ee6b872d386dd290f29e48d">CudaBackend</a> (const std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > params)</td></tr>
<tr class="memdesc:ae19e277a3ee6b872d386dd290f29e48d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classrr_1_1_cuda_backend.html" title="This interface class manages the creation of CUDA Algorithms and CUDA Buffers.">CudaBackend</a> instance. <a href="classrr_1_1_cuda_backend.html#ae19e277a3ee6b872d386dd290f29e48d">More...</a><br /></td></tr>
<tr class="separator:ae19e277a3ee6b872d386dd290f29e48d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45b4944a2ff0915b78d85b38ce19a4be"><td class="memItemLeft" align="right" valign="top">virtual const std::shared_ptr< <a class="el" href="classrr_1_1_i_algorithm.html">IAlgorithm</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_backend.html#a45b4944a2ff0915b78d85b38ce19a4be">CreateAlgorithm</a> (const <a class="el" href="namespacerr.html#ad871bf3757e93d5b1434873abdcf1939">Algorithms</a> algorithm, const std::shared_ptr< <a class="el" href="classrr_1_1_i_settings.html">ISettings</a> > settings)</td></tr>
<tr class="memdesc:a45b4944a2ff0915b78d85b38ce19a4be"><td class="mdescLeft"> </td><td class="mdescRight">This method constructs the algorithm that runs on the backend. <a href="classrr_1_1_cuda_backend.html#a45b4944a2ff0915b78d85b38ce19a4be">More...</a><br /></td></tr>
<tr class="separator:a45b4944a2ff0915b78d85b38ce19a4be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f90c10a39e21fd089ce0a4850affeb4"><td class="memItemLeft" align="right" valign="top">virtual const std::shared_ptr< <a class="el" href="classrr_1_1_buffer.html">Buffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_backend.html#a9f90c10a39e21fd089ce0a4850affeb4">CreateBuffer</a> (uint8_t *data, const size_t size, const std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > params)</td></tr>
<tr class="memdesc:a9f90c10a39e21fd089ce0a4850affeb4"><td class="mdescLeft"> </td><td class="mdescRight">This method constructs a <a class="el" href="classrr_1_1_cuda_buffer.html" title="This class contains data of the CudaBuffer.">CudaBuffer</a>. <a href="classrr_1_1_cuda_backend.html#a9f90c10a39e21fd089ce0a4850affeb4">More...</a><br /></td></tr>
<tr class="separator:a9f90c10a39e21fd089ce0a4850affeb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a819cd6a7470e0cda07910ad997274366"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classrr_1_1_runtime_error.html">RuntimeError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_backend.html#a819cd6a7470e0cda07910ad997274366">Synchronize</a> ()</td></tr>
<tr class="memdesc:a819cd6a7470e0cda07910ad997274366"><td class="mdescLeft"> </td><td class="mdescRight">This method synchronizes the whole execution backend. <a href="classrr_1_1_cuda_backend.html#a819cd6a7470e0cda07910ad997274366">More...</a><br /></td></tr>
<tr class="separator:a819cd6a7470e0cda07910ad997274366"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31eabccabc3a5c475d9d3878cc72ec39"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_cuda_backend.html#a31eabccabc3a5c475d9d3878cc72ec39">~CudaBackend</a> ()</td></tr>
<tr class="memdesc:a31eabccabc3a5c475d9d3878cc72ec39"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the <a class="el" href="classrr_1_1_cuda_backend.html" title="This interface class manages the creation of CUDA Algorithms and CUDA Buffers.">CudaBackend</a> object. <a href="classrr_1_1_cuda_backend.html#a31eabccabc3a5c475d9d3878cc72ec39">More...</a><br /></td></tr>
<tr class="separator:a31eabccabc3a5c475d9d3878cc72ec39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classrr_1_1_i_backend"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classrr_1_1_i_backend')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classrr_1_1_i_backend.html">rr::IBackend</a></td></tr>
<tr class="memitem:a3476f8385f013949c75d2df3f0cc6604 inherit pub_methods_classrr_1_1_i_backend"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_backend.html#a3476f8385f013949c75d2df3f0cc6604">~IBackend</a> ()=default</td></tr>
<tr class="memdesc:a3476f8385f013949c75d2df3f0cc6604 inherit pub_methods_classrr_1_1_i_backend"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the <a class="el" href="classrr_1_1_i_backend.html" title="This interface provides an execution environment for the algorithms.">IBackend</a> object. <a href="classrr_1_1_i_backend.html#a3476f8385f013949c75d2df3f0cc6604">More...</a><br /></td></tr>
<tr class="separator:a3476f8385f013949c75d2df3f0cc6604 inherit pub_methods_classrr_1_1_i_backend"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classrr_1_1_i_backend"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classrr_1_1_i_backend')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classrr_1_1_i_backend.html">rr::IBackend</a></td></tr>
<tr class="memitem:a778ea739fab702603ea56d71773557d4 inherit pub_static_methods_classrr_1_1_i_backend"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classrr_1_1_i_backend.html">IBackend</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classrr_1_1_i_backend.html#a778ea739fab702603ea56d71773557d4">Build</a> (const <a class="el" href="namespacerr.html#a9a195b1fe61957966b62edcaca6db31a">Backends</a> backend, const std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > params)</td></tr>
<tr class="memdesc:a778ea739fab702603ea56d71773557d4 inherit pub_static_methods_classrr_1_1_i_backend"><td class="mdescLeft"> </td><td class="mdescRight">This method construct the backend objects. <a href="classrr_1_1_i_backend.html#a778ea739fab702603ea56d71773557d4">More...</a><br /></td></tr>
<tr class="separator:a778ea739fab702603ea56d71773557d4 inherit pub_static_methods_classrr_1_1_i_backend"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This interface class manages the creation of CUDA Algorithms and CUDA Buffers. </p>
<p>The <a class="el" href="classrr_1_1_cuda_backend.html#a45b4944a2ff0915b78d85b38ce19a4be" title="This method constructs the algorithm that runs on the backend.">CudaBackend::CreateAlgorithm</a> and <a class="el" href="classrr_1_1_cuda_backend.html#a9f90c10a39e21fd089ce0a4850affeb4" title="This method constructs a CudaBuffer.">CudaBackend::CreateBuffer</a> methods build Cuda Algorithms (Look at the Algorithms enumeration to see available options) and CudaBuffers respectively. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ae19e277a3ee6b872d386dd290f29e48d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae19e277a3ee6b872d386dd290f29e48d">◆ </a></span>CudaBackend()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rr::CudaBackend::CudaBackend </td>
<td>(</td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > </td>
<td class="paramname"><em>params</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="classrr_1_1_cuda_backend.html" title="This interface class manages the creation of CUDA Algorithms and CUDA Buffers.">CudaBackend</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">params</td><td>: Contains the parameters necessary for the backend. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a31eabccabc3a5c475d9d3878cc72ec39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31eabccabc3a5c475d9d3878cc72ec39">◆ </a></span>~CudaBackend()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rr::CudaBackend::~CudaBackend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the <a class="el" href="classrr_1_1_cuda_backend.html" title="This interface class manages the creation of CUDA Algorithms and CUDA Buffers.">CudaBackend</a> object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a45b4944a2ff0915b78d85b38ce19a4be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45b4944a2ff0915b78d85b38ce19a4be">◆ </a></span>CreateAlgorithm()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::shared_ptr< <a class="el" href="classrr_1_1_i_algorithm.html">IAlgorithm</a> > rr::CudaBackend::CreateAlgorithm </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacerr.html#ad871bf3757e93d5b1434873abdcf1939">Algorithms</a> </td>
<td class="paramname"><em>algorithm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classrr_1_1_i_settings.html">ISettings</a> > </td>
<td class="paramname"><em>settings</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method constructs the algorithm that runs on the backend. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">algorithm</td><td>: Algorithm that will be constructed. </td></tr>
<tr><td class="paramname">settings</td><td>: Settings for the algorithm to be constructed. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a>: Operation status. </dd></dl>
<p>Implements <a class="el" href="classrr_1_1_i_backend.html#a3a00481cb4eaa7e32090351b6b156122">rr::IBackend</a>.</p>
</div>
</div>
<a id="a9f90c10a39e21fd089ce0a4850affeb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f90c10a39e21fd089ce0a4850affeb4">◆ </a></span>CreateBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::shared_ptr< <a class="el" href="classrr_1_1_buffer.html">Buffer</a> > rr::CudaBackend::CreateBuffer </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classrr_1_1_i_params.html">IParams</a> > </td>
<td class="paramname"><em>params</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method constructs a <a class="el" href="classrr_1_1_cuda_buffer.html" title="This class contains data of the CudaBuffer.">CudaBuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>: Pointer to data memory for the buffer to hold </td></tr>
<tr><td class="paramname">size</td><td>: Data memory size </td></tr>
<tr><td class="paramname">params</td><td>: <a class="el" href="classrr_1_1_cuda_buffer_params.html" title="This class encapsulates the parameters used in building a CudaBuffer.">CudaBufferParams</a> containing the memory CudaType </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a>: Operation status. </dd></dl>
<p>Implements <a class="el" href="classrr_1_1_i_backend.html#a771bc64eb4881f6abf837cfb915921a5">rr::IBackend</a>.</p>
</div>
</div>
<a id="a819cd6a7470e0cda07910ad997274366"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a819cd6a7470e0cda07910ad997274366">◆ </a></span>Synchronize()</h2>
<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="classrr_1_1_runtime_error.html">RuntimeError</a> rr::CudaBackend::Synchronize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method synchronizes the whole execution backend. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrr_1_1_runtime_error.html" title="Implements the error handling class.">RuntimeError</a> : Operation status. </dd></dl>
<p>Implements <a class="el" href="classrr_1_1_i_backend.html#aed6f598f4bf30260a3ed509f83c58957">rr::IBackend</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/builds/ridgerun/rnd/libcudaisp/rr/include/libcudaisp/<a class="el" href="cudabackend_8hpp_source.html">cudabackend.hpp</a></li>
<li>/builds/ridgerun/rnd/libcudaisp/rr/lib/<a class="el" href="cudabackend_8cpp.html">cudabackend.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 14 2023 20:22:00 for libcudaisp by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>