arrayfire-python/arrayfire.opencl.html at gh-pages · arrayfire/arrayfire-python · GitHub

Repository navigation

History

297 lines (238 loc) · 17.2 KB

Raw

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

<!DOCTYPE html>

<html>

<head>

<title>arrayfire.opencl module — ArrayFire Python documentation</title>

</head><body>

<h1>arrayfire.opencl module<a class="headerlink" href="#module-arrayfire.opencl" title="Permalink to this headline">¶</a></h1>

Functions specific to OpenCL backend.

This module provides interoperability with other OpenCL libraries.

class <code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">DEVICE_TYPE</code>(value)<a class="reference internal" href="_modules/arrayfire/opencl.html#DEVICE_TYPE">[source]</a><a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">enum.Enum</code>

ArrayFire wrapper for CL_DEVICE_TYPE

<code class="sig-name descname">UNKNOWN</code> = -1<a class="headerlink" href="#arrayfire.opencl.DEVICE_TYPE.UNKNOWN" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">PLATFORM</code>(value)<a class="reference internal" href="_modules/arrayfire/opencl.html#PLATFORM">[source]</a><a class="headerlink" href="#arrayfire.opencl.PLATFORM" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">enum.Enum</code>

ArrayFire enum for common platforms

<code class="sig-name descname">APPLE</code> = 1<a class="headerlink" href="#arrayfire.opencl.PLATFORM.APPLE" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">BEIGNET</code> = 4<a class="headerlink" href="#arrayfire.opencl.PLATFORM.BEIGNET" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">INTEL</code> = 2<a class="headerlink" href="#arrayfire.opencl.PLATFORM.INTEL" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">NVIDIA</code> = 3<a class="headerlink" href="#arrayfire.opencl.PLATFORM.NVIDIA" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">UNKNOWN</code> = -1<a class="headerlink" href="#arrayfire.opencl.PLATFORM.UNKNOWN" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">add_device_context</code>(dev, ctx, que)<a class="reference internal" href="_modules/arrayfire/opencl.html#add_device_context">[source]</a><a class="headerlink" href="#arrayfire.opencl.add_device_context" title="Permalink to this definition">¶</a></dt>

<dd>Add a new device to arrayfire opencl device manager

<dt class="field-odd">Parameters</dt>

<dt>devcl_device_id</dt><dd></dd>

<dt>ctxcl_context</dt><dd></dd>

<dt>quecl_command_queue</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">delete_device_context</code>(dev, ctx)<a class="reference internal" href="_modules/arrayfire/opencl.html#delete_device_context">[source]</a><a class="headerlink" href="#arrayfire.opencl.delete_device_context" title="Permalink to this definition">¶</a></dt>

<dd>Delete a device

<dt class="field-odd">Parameters</dt>

<dt>devcl_device_id</dt><dd></dd>

<dt>ctxcl_context</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">get_context</code>(retain=False)<a class="reference internal" href="_modules/arrayfire/opencl.html#get_context">[source]</a><a class="headerlink" href="#arrayfire.opencl.get_context" title="Permalink to this definition">¶</a></dt>

<dd>Get the current OpenCL context being used by ArrayFire.

<dt class="field-odd">Parameters</dt>

<dt>retainbool. optional. Default: False.</dt><dd>Specifies if the context needs to be retained by arrayfire before returning.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>contextinteger denoting the context id.</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">get_device_id</code>()<a class="reference internal" href="_modules/arrayfire/opencl.html#get_device_id">[source]</a><a class="headerlink" href="#arrayfire.opencl.get_device_id" title="Permalink to this definition">¶</a></dt>

<dd>Get native (unsorted) OpenCL device ID

<dt class="field-odd">Returns</dt>

<dt>idxint.</dt><dd>Specifies the <cite>cl_device_id</cite> of the device.

</dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">get_device_type</code>()<a class="reference internal" href="_modules/arrayfire/opencl.html#get_device_type">[source]</a><a class="headerlink" href="#arrayfire.opencl.get_device_type" title="Permalink to this definition">¶</a></dt>

<dd>Get opencl device type

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">get_platform</code>()<a class="reference internal" href="_modules/arrayfire/opencl.html#get_platform">[source]</a><a class="headerlink" href="#arrayfire.opencl.get_platform" title="Permalink to this definition">¶</a></dt>

<dd>Get opencl platform

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">get_queue</code>(retain)<a class="reference internal" href="_modules/arrayfire/opencl.html#get_queue">[source]</a><a class="headerlink" href="#arrayfire.opencl.get_queue" title="Permalink to this definition">¶</a></dt>

<dd>Get the current OpenCL command queue being used by ArrayFire.

<dt class="field-odd">Parameters</dt>

<dt>retainbool. optional. Default: False.</dt><dd>Specifies if the context needs to be retained by arrayfire before returning.

</dd>

</dl>

</dd>

<dt class="field-even">Returns</dt>

<dt>queueinteger denoting the queue id.</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">set_device_context</code>(dev, ctx)<a class="reference internal" href="_modules/arrayfire/opencl.html#set_device_context">[source]</a><a class="headerlink" href="#arrayfire.opencl.set_device_context" title="Permalink to this definition">¶</a></dt>

<dd>Set a device as current active device

<dt class="field-odd">Parameters</dt>

<dt>devcl_device_id</dt><dd></dd>

<dt>ctxcl_context</dt><dd></dd>

</dl>

</dd>

</dl>

</dd></dl>

<code class="sig-prename descclassname">arrayfire.opencl.</code><code class="sig-name descname">set_device_id</code>(idx)<a class="reference internal" href="_modules/arrayfire/opencl.html#set_device_id">[source]</a><a class="headerlink" href="#arrayfire.opencl.set_device_id" title="Permalink to this definition">¶</a></dt>

<dd>Set native (unsorted) OpenCL device ID

<dt class="field-odd">Parameters</dt>

<dt>idxint.</dt><dd>Specifies the <cite>cl_device_id</cite> of the device.

</dd>

</dl>

</dd>

</dl>

</dd></dl>

</div>

</a>

<h1 class="logo"><a href="index.html">ArrayFire</a></h1>

<h3>Navigation</h3>

<h3>Related Topics</h3>

<ul>

<li><a href="index.html">Documentation overview</a><ul>

</ul></li>

</ul>

</div>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</div>

</div>

& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

<a href="_sources/arrayfire.opencl.rst.txt"

rel="nofollow">Page source</a>

</div>

</body>

</html>

arrayfire-python/arrayfire.opencl.html at gh-pages · arrayfire/arrayfire-python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

arrayfire.opencl.html

Latest commit

History

Breadcrumbs

arrayfire.opencl.html

File metadata and controls