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
|
<!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/ocl/forwards.h Source File</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('ocl_2forwards_8h_source.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="headertitle">
<div class="title">forwards.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ocl_2forwards_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef VIENNACL_OCL_FORWARDS_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define VIENNACL_OCL_FORWARDS_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* =========================================================================</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> Copyright (c) 2010-2016, Institute for Microelectronics,</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Institute for Analysis and Scientific Computing,</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> TU Wien.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Portions of this software are copyright by UChicago Argonne, LLC.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> -----------------</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ViennaCL - The Vienna Computing Library</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> -----------------</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Project Head: Karl Rupp rupp@iue.tuwien.ac.at</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> (A list of authors and contributors can be found in the manual)</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> License: MIT (X11), see file LICENSE in the base directory</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">============================================================================= */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="ocl_2forwards_8h.html#a2d90eef0a67b2af2801368b3ab5b357f"> 25</a></span> <span class="preprocessor">#define VIENNACL_OCL_MAX_DEVICE_NUM 8</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <stddef.h></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>viennacl</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">namespace </span>ocl</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">//device type tags (cf. OpenCL standard)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structviennacl_1_1ocl_1_1gpu__tag.html"> 35</a></span> <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structviennacl_1_1ocl_1_1gpu__tag.html">gpu_tag</a> {};</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structviennacl_1_1ocl_1_1cpu__tag.html"> 37</a></span>  <span class="keyword">struct </span><a class="code" href="structviennacl_1_1ocl_1_1cpu__tag.html">cpu_tag</a> {};</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structviennacl_1_1ocl_1_1accelerator__tag.html"> 39</a></span>  <span class="keyword">struct </span><a class="code" href="structviennacl_1_1ocl_1_1accelerator__tag.html">accelerator_tag</a> {};</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structviennacl_1_1ocl_1_1default__tag.html"> 41</a></span>  <span class="keyword">struct </span><a class="code" href="structviennacl_1_1ocl_1_1default__tag.html">default_tag</a> {};</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">class </span><a class="code" href="classviennacl_1_1ocl_1_1kernel.html">kernel</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">class </span><a class="code" href="classviennacl_1_1ocl_1_1device.html">device</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">class </span><a class="code" href="classviennacl_1_1ocl_1_1command__queue.html">command_queue</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">class </span><a class="code" href="classviennacl_1_1ocl_1_1context.html">context</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">class </span><a class="code" href="classviennacl_1_1ocl_1_1program.html">program</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">template</span><<span class="keyword">class</span> OCL_TYPE></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classviennacl_1_1ocl_1_1handle.html"> 51</a></span>  <span class="keyword">class </span><a class="code" href="classviennacl_1_1ocl_1_1handle.html">handle</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">template</span><<span class="keyword">typename</span> KernelType></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="namespaceviennacl_1_1ocl.html#a5f2022f653ea1cf364d20e3ff84dcada">enqueue</a>(KernelType & k, <a class="code" href="classviennacl_1_1ocl_1_1command__queue.html">viennacl::ocl::command_queue</a> <span class="keyword">const</span> & queue);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">inline</span> <a class="code" href="classviennacl_1_1ocl_1_1context.html">viennacl::ocl::context</a> & <a class="code" href="namespaceviennacl_1_1ocl.html#a16fc917445ce2010e7b16fbc968771b7">current_context</a>();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">inline</span> <a class="code" href="classviennacl_1_1ocl_1_1device.html">viennacl::ocl::device</a> <span class="keyword">const</span> & <a class="code" href="namespaceviennacl_1_1ocl.html#ac54d59a74deaccec81f64e738b856348">current_device</a>();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">//namespace viennacl</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="ttc" id="structviennacl_1_1ocl_1_1gpu__tag_html"><div class="ttname"><a href="structviennacl_1_1ocl_1_1gpu__tag.html">viennacl::ocl::gpu_tag</a></div><div class="ttdoc">A tag identifying OpenCL devices as GPUs. </div><div class="ttdef"><b>Definition:</b> <a href="ocl_2forwards_8h_source.html#l00035">forwards.h:35</a></div></div>
<div class="ttc" id="classviennacl_1_1ocl_1_1kernel_html"><div class="ttname"><a href="classviennacl_1_1ocl_1_1kernel.html">viennacl::ocl::kernel</a></div><div class="ttdoc">Represents an OpenCL kernel within ViennaCL. </div><div class="ttdef"><b>Definition:</b> <a href="kernel_8hpp_source.html#l00058">kernel.hpp:58</a></div></div>
<div class="ttc" id="namespaceviennacl_1_1ocl_html_a16fc917445ce2010e7b16fbc968771b7"><div class="ttname"><a href="namespaceviennacl_1_1ocl.html#a16fc917445ce2010e7b16fbc968771b7">viennacl::ocl::current_context</a></div><div class="ttdeci">viennacl::ocl::context & current_context()</div><div class="ttdoc">Convenience function for returning the current context. </div><div class="ttdef"><b>Definition:</b> <a href="backend_8hpp_source.html#l00213">backend.hpp:213</a></div></div>
<div class="ttc" id="classviennacl_1_1ocl_1_1context_html"><div class="ttname"><a href="classviennacl_1_1ocl_1_1context.html">viennacl::ocl::context</a></div><div class="ttdoc">Manages an OpenCL context and provides the respective convenience functions for creating buffers...</div><div class="ttdef"><b>Definition:</b> <a href="ocl_2context_8hpp_source.html#l00055">context.hpp:55</a></div></div>
<div class="ttc" id="structviennacl_1_1ocl_1_1cpu__tag_html"><div class="ttname"><a href="structviennacl_1_1ocl_1_1cpu__tag.html">viennacl::ocl::cpu_tag</a></div><div class="ttdoc">A tag identifying OpenCL devices as CPUs. </div><div class="ttdef"><b>Definition:</b> <a href="ocl_2forwards_8h_source.html#l00037">forwards.h:37</a></div></div>
<div class="ttc" id="classviennacl_1_1ocl_1_1device_html"><div class="ttname"><a href="classviennacl_1_1ocl_1_1device.html">viennacl::ocl::device</a></div><div class="ttdoc">A class representing a compute device (e.g. a GPU) </div><div class="ttdef"><b>Definition:</b> <a href="device_8hpp_source.html#l00049">device.hpp:49</a></div></div>
<div class="ttc" id="classviennacl_1_1ocl_1_1command__queue_html"><div class="ttname"><a href="classviennacl_1_1ocl_1_1command__queue.html">viennacl::ocl::command_queue</a></div><div class="ttdoc">A class representing a command queue. </div><div class="ttdef"><b>Definition:</b> <a href="command__queue_8hpp_source.html#l00045">command_queue.hpp:45</a></div></div>
<div class="ttc" id="namespaceviennacl_1_1ocl_html_ac54d59a74deaccec81f64e738b856348"><div class="ttname"><a href="namespaceviennacl_1_1ocl.html#ac54d59a74deaccec81f64e738b856348">viennacl::ocl::current_device</a></div><div class="ttdeci">viennacl::ocl::device const & current_device()</div><div class="ttdoc">Convenience function for returning the active device in the current context. </div><div class="ttdef"><b>Definition:</b> <a href="backend_8hpp_source.html#l00351">backend.hpp:351</a></div></div>
<div class="ttc" id="structviennacl_1_1ocl_1_1accelerator__tag_html"><div class="ttname"><a href="structviennacl_1_1ocl_1_1accelerator__tag.html">viennacl::ocl::accelerator_tag</a></div><div class="ttdoc">A tag identifying OpenCL devices as accelerators (e.g. Intel Xeon Phi) </div><div class="ttdef"><b>Definition:</b> <a href="ocl_2forwards_8h_source.html#l00039">forwards.h:39</a></div></div>
<div class="ttc" id="classviennacl_1_1ocl_1_1program_html"><div class="ttname"><a href="classviennacl_1_1ocl_1_1program.html">viennacl::ocl::program</a></div><div class="ttdoc">Wrapper class for an OpenCL program. </div><div class="ttdef"><b>Definition:</b> <a href="program_8hpp_source.html#l00042">program.hpp:42</a></div></div>
<div class="ttc" id="namespaceviennacl_1_1ocl_html_a5f2022f653ea1cf364d20e3ff84dcada"><div class="ttname"><a href="namespaceviennacl_1_1ocl.html#a5f2022f653ea1cf364d20e3ff84dcada">viennacl::ocl::enqueue</a></div><div class="ttdeci">void enqueue(KernelType &k, viennacl::ocl::command_queue const &queue)</div><div class="ttdoc">Enqueues a kernel in the provided queue. </div><div class="ttdef"><b>Definition:</b> <a href="enqueue_8hpp_source.html#l00050">enqueue.hpp:50</a></div></div>
<div class="ttc" id="structviennacl_1_1ocl_1_1default__tag_html"><div class="ttname"><a href="structviennacl_1_1ocl_1_1default__tag.html">viennacl::ocl::default_tag</a></div><div class="ttdoc">A tag denoting the default OpenCL device type (SDK-specific) </div><div class="ttdef"><b>Definition:</b> <a href="ocl_2forwards_8h_source.html#l00041">forwards.h:41</a></div></div>
<div class="ttc" id="classviennacl_1_1ocl_1_1handle_html"><div class="ttname"><a href="classviennacl_1_1ocl_1_1handle.html">viennacl::ocl::handle</a></div><div class="ttdoc">Handle class the effectively represents a smart pointer for OpenCL handles. </div><div class="ttdef"><b>Definition:</b> <a href="ocl_2forwards_8h_source.html#l00051">forwards.h:51</a></div></div>
</div><!-- fragment --></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_9d83cdcad950ebf3600600fb35f63223.html">ocl</a></li><li class="navelem"><a class="el" href="ocl_2forwards_8h.html">forwards.h</a></li>
<li class="footer">Generated on Wed Jan 20 2016 22:32:40 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>
|
