-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassaf_1_1event.htm
More file actions
292 lines (268 loc) · 14.7 KB
/
classaf_1_1event.htm
File metadata and controls
292 lines (268 loc) · 14.7 KB
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
<!-- HTML header for doxygen 1.9.5-->
<!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" lang="en-US">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-130950618-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-130950618-1');
</script>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArrayFire: event 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="arrayfire.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeFragmentCopyButton.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="2" cellpadding="2" width="100%">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><a href="index.htm"><img alt="Logo" src="arrayfire_logo.png"/></a></td>
</tr>
<tr id="projectrow">
<td>
<div id="projectbrief">A high-performance general-purpose compute library</div>
</td>
</tr>
<!--END !PROJECT_NAME-->
<div>
<td id="gsearch">
<script async src="https://cse.google.com/cse.js?cx=004356362924927882526:zup3ehe-7bs"></script>
<div class="gcse-search"></div>
</td>
</div>
</tr>
<tr>
<td>
<div id="togglediv"></div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part --><!-- Generated by Doxygen 1.9.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="tutorials.htm"><span>Tutorials</span></a></li>
<li><a href="modules.htm"><span>Functions</span></a></li>
<li><a href="releasenotes.htm"><span>Release Notes</span></a></li>
<li><a href="examples.htm"><span>Examples</span></a></li>
</ul>
</div>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classaf_1_1event.htm',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle"><div class="title">event Class Reference<div class="ingroups"><a class="el" href="group__arrayfire__class.htm">ArrayFire Classes</a> | <a class="el" href="group__func__categories.htm">ArrayFire Functions by Category</a> » <a class="el" href="group__event.htm">Events</a> » <a class="el" href="group__event__api.htm">Event API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>C++ RAII interface for manipulating events.
<a href="classaf_1_1event.htm#details">More...</a></p>
<p><code>#include <<a class="el" href="event_8h_source.htm">event.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7fcfed0c370817eaf7e5fad427ed2195"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#a7fcfed0c370817eaf7e5fad427ed2195">event</a> (<a class="el" href="group__event__api.htm#gadd8ed31422f37894e6286e931d30d23d">af_event</a> e)</td></tr>
<tr class="memdesc:a7fcfed0c370817eaf7e5fad427ed2195"><td class="mdescLeft"> </td><td class="mdescRight">Create a new event using the C af_event handle. <a href="classaf_1_1event.htm#a7fcfed0c370817eaf7e5fad427ed2195">More...</a><br /></td></tr>
<tr class="separator:a7fcfed0c370817eaf7e5fad427ed2195"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae955a1615b8ede623178becf694066bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#ae955a1615b8ede623178becf694066bb">event</a> ()</td></tr>
<tr class="memdesc:ae955a1615b8ede623178becf694066bb"><td class="mdescLeft"> </td><td class="mdescRight">Create a new event object. <a href="classaf_1_1event.htm#ae955a1615b8ede623178becf694066bb">More...</a><br /></td></tr>
<tr class="separator:ae955a1615b8ede623178becf694066bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67506d998164291b0d280a6b8e57af0b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#a67506d998164291b0d280a6b8e57af0b">~event</a> ()</td></tr>
<tr class="memdesc:a67506d998164291b0d280a6b8e57af0b"><td class="mdescLeft"> </td><td class="mdescRight">event Destructor <a href="classaf_1_1event.htm#a67506d998164291b0d280a6b8e57af0b">More...</a><br /></td></tr>
<tr class="separator:a67506d998164291b0d280a6b8e57af0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4a32afe8e3d901035338a2d19e8b1f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__event__api.htm#gadd8ed31422f37894e6286e931d30d23d">af_event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#af4a32afe8e3d901035338a2d19e8b1f8">get</a> () const</td></tr>
<tr class="memdesc:af4a32afe8e3d901035338a2d19e8b1f8"><td class="mdescLeft"> </td><td class="mdescRight">Return the underlying C af_event handle. <a href="classaf_1_1event.htm#af4a32afe8e3d901035338a2d19e8b1f8">More...</a><br /></td></tr>
<tr class="separator:af4a32afe8e3d901035338a2d19e8b1f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a846b07e015bf52abc7627cb98a8136b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#a846b07e015bf52abc7627cb98a8136b6">mark</a> ()</td></tr>
<tr class="memdesc:a846b07e015bf52abc7627cb98a8136b6"><td class="mdescLeft"> </td><td class="mdescRight">Adds the event on the default ArrayFire queue. <a href="classaf_1_1event.htm#a846b07e015bf52abc7627cb98a8136b6">More...</a><br /></td></tr>
<tr class="separator:a846b07e015bf52abc7627cb98a8136b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f2a57de7572f241721cb967c9eac2ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#a2f2a57de7572f241721cb967c9eac2ed">enqueue</a> ()</td></tr>
<tr class="memdesc:a2f2a57de7572f241721cb967c9eac2ed"><td class="mdescLeft"> </td><td class="mdescRight">Block the ArrayFire queue until this even has occurred. <a href="classaf_1_1event.htm#a2f2a57de7572f241721cb967c9eac2ed">More...</a><br /></td></tr>
<tr class="separator:a2f2a57de7572f241721cb967c9eac2ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a199039b291e75cdbae27b4ca1ecd1879"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1event.htm#a199039b291e75cdbae27b4ca1ecd1879">block</a> () const</td></tr>
<tr class="memdesc:a199039b291e75cdbae27b4ca1ecd1879"><td class="mdescLeft"> </td><td class="mdescRight">block the calling thread until this event has occurred <a href="classaf_1_1event.htm#a199039b291e75cdbae27b4ca1ecd1879">More...</a><br /></td></tr>
<tr class="separator:a199039b291e75cdbae27b4ca1ecd1879"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >C++ RAII interface for manipulating events. </p>
<p class="definition">Definition at line <a class="el" href="event_8h_source.htm#l00031">31</a> of file <a class="el" href="event_8h_source.htm">event.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7fcfed0c370817eaf7e5fad427ed2195" name="a7fcfed0c370817eaf7e5fad427ed2195"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fcfed0c370817eaf7e5fad427ed2195">◆ </a></span>event() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1event.htm">event</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__api.htm#gadd8ed31422f37894e6286e931d30d23d">af_event</a> </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new event using the C af_event handle. </p>
</div>
</div>
<a id="ae955a1615b8ede623178becf694066bb" name="ae955a1615b8ede623178becf694066bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae955a1615b8ede623178becf694066bb">◆ </a></span>event() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1event.htm">event</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new event object. </p>
</div>
</div>
<a id="a67506d998164291b0d280a6b8e57af0b" name="a67506d998164291b0d280a6b8e57af0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67506d998164291b0d280a6b8e57af0b">◆ </a></span>~event()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classaf_1_1event.htm">event</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>event Destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a199039b291e75cdbae27b4ca1ecd1879" name="a199039b291e75cdbae27b4ca1ecd1879"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a199039b291e75cdbae27b4ca1ecd1879">◆ </a></span>block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void block </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>block the calling thread until this event has occurred </p>
</div>
</div>
<a id="a2f2a57de7572f241721cb967c9eac2ed" name="a2f2a57de7572f241721cb967c9eac2ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f2a57de7572f241721cb967c9eac2ed">◆ </a></span>enqueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void enqueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Block the ArrayFire queue until this even has occurred. </p>
</div>
</div>
<a id="af4a32afe8e3d901035338a2d19e8b1f8" name="af4a32afe8e3d901035338a2d19e8b1f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4a32afe8e3d901035338a2d19e8b1f8">◆ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__event__api.htm#gadd8ed31422f37894e6286e931d30d23d">af_event</a> get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the underlying C af_event handle. </p>
</div>
</div>
<a id="a846b07e015bf52abc7627cb98a8136b6" name="a846b07e015bf52abc7627cb98a8136b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a846b07e015bf52abc7627cb98a8136b6">◆ </a></span>mark()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mark </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the event on the default ArrayFire queue. </p>
<p >Once this point on the program is executed, the event is considered complete. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="event_8h_source.htm">event.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.3-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceaf.htm">af</a></li><li class="navelem"><a class="el" href="classaf_1_1event.htm">event</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
</ul>
</div>
</body>
</html>