forked from arrayfire/arrayfire-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharrayfire.opencl.html
More file actions
310 lines (268 loc) · 15.6 KB
/
arrayfire.opencl.html
File metadata and controls
310 lines (268 loc) · 15.6 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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<!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/html; charset=utf-8" />
<title>arrayfire.opencl module — ArrayFire Python documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.4.20160925',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="ArrayFire Python documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-arrayfire.opencl">
<span id="arrayfire-opencl-module"></span><h1>arrayfire.opencl module<a class="headerlink" href="#module-arrayfire.opencl" title="Permalink to this headline">¶</a></h1>
<p>Functions specific to OpenCL backend.</p>
<p>This module provides interoperability with other OpenCL libraries.</p>
<dl class="class">
<dt id="arrayfire.opencl.DEVICE_TYPE">
<em class="property">class </em><code class="descclassname">arrayfire.opencl.</code><code class="descname">DEVICE_TYPE</code><a class="reference internal" href="_modules/arrayfire/opencl.html#DEVICE_TYPE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
<p>ArrayFire wrapper for CL_DEVICE_TYPE</p>
<dl class="attribute">
<dt id="arrayfire.opencl.DEVICE_TYPE.ACC">
<code class="descname">ACC</code><em class="property"> = <DEVICE_TYPE.ACC: 8></em><a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE.ACC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.DEVICE_TYPE.CPU">
<code class="descname">CPU</code><em class="property"> = <DEVICE_TYPE.CPU: 2></em><a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE.CPU" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.DEVICE_TYPE.GPU">
<code class="descname">GPU</code><em class="property"> = <DEVICE_TYPE.GPU: 4></em><a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE.GPU" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.DEVICE_TYPE.UNKNOWN">
<code class="descname">UNKNOWN</code><em class="property"> = <DEVICE_TYPE.UNKNOWN: -1></em><a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE.UNKNOWN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="arrayfire.opencl.PLATFORM">
<em class="property">class </em><code class="descclassname">arrayfire.opencl.</code><code class="descname">PLATFORM</code><a class="reference internal" href="_modules/arrayfire/opencl.html#PLATFORM"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.PLATFORM" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
<p>ArrayFire enum for common platforms</p>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.AMD">
<code class="descname">AMD</code><em class="property"> = <PLATFORM.AMD: 0></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.AMD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.APPLE">
<code class="descname">APPLE</code><em class="property"> = <PLATFORM.APPLE: 1></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.APPLE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.BEIGNET">
<code class="descname">BEIGNET</code><em class="property"> = <PLATFORM.BEIGNET: 4></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.BEIGNET" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.INTEL">
<code class="descname">INTEL</code><em class="property"> = <PLATFORM.INTEL: 2></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.INTEL" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.NVIDIA">
<code class="descname">NVIDIA</code><em class="property"> = <PLATFORM.NVIDIA: 3></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.NVIDIA" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.POCL">
<code class="descname">POCL</code><em class="property"> = <PLATFORM.POCL: 5></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.POCL" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="arrayfire.opencl.PLATFORM.UNKNOWN">
<code class="descname">UNKNOWN</code><em class="property"> = <PLATFORM.UNKNOWN: -1></em><a class="headerlink" href="#arrayfire.opencl.PLATFORM.UNKNOWN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.add_device_context">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">add_device_context</code><span class="sig-paren">(</span><em>dev</em>, <em>ctx</em>, <em>que</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#add_device_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.add_device_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new device to arrayfire opencl device manager</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>dev</strong> : cl_device_id</p>
<p><strong>ctx</strong> : cl_context</p>
<p class="last"><strong>que</strong> : cl_command_queue</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.delete_device_context">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">delete_device_context</code><span class="sig-paren">(</span><em>dev</em>, <em>ctx</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#delete_device_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.delete_device_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a device</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>dev</strong> : cl_device_id</p>
<p class="last"><strong>ctx</strong> : cl_context</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.get_context">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">get_context</code><span class="sig-paren">(</span><em>retain=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#get_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.get_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the current OpenCL context being used by ArrayFire.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>retain</strong> : bool. optional. Default: False.</p>
<blockquote>
<div><p>Specifies if the context needs to be retained by arrayfire before returning.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>context</strong> : integer denoting the context id.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.get_device_id">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">get_device_id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#get_device_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.get_device_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Get native (unsorted) OpenCL device ID</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>idx</strong> : int.</p>
<blockquote class="last">
<div><p>Specifies the <cite>cl_device_id</cite> of the device.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.get_device_type">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">get_device_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#get_device_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.get_device_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Get opencl device type</p>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.get_platform">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">get_platform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#get_platform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.get_platform" title="Permalink to this definition">¶</a></dt>
<dd><p>Get opencl platform</p>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.get_queue">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">get_queue</code><span class="sig-paren">(</span><em>retain</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#get_queue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.get_queue" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the current OpenCL command queue being used by ArrayFire.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>retain</strong> : bool. optional. Default: False.</p>
<blockquote>
<div><p>Specifies if the context needs to be retained by arrayfire before returning.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>queue</strong> : integer denoting the queue id.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.set_device_context">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">set_device_context</code><span class="sig-paren">(</span><em>dev</em>, <em>ctx</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#set_device_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.set_device_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a device as current active device</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>dev</strong> : cl_device_id</p>
<p class="last"><strong>ctx</strong> : cl_context</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="arrayfire.opencl.set_device_id">
<code class="descclassname">arrayfire.opencl.</code><code class="descname">set_device_id</code><span class="sig-paren">(</span><em>idx</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/opencl.html#set_device_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#arrayfire.opencl.set_device_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Set native (unsorted) OpenCL device ID</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>idx</strong> : int.</p>
<blockquote class="last">
<div><p>Specifies the <cite>cl_device_id</cite> of the device.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/arrayfire_logo_symbol.png" alt="Logo"/>
</a></p><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/arrayfire.opencl.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, Pavan Yalamanchili.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
|
<a href="_sources/arrayfire.opencl.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>