forked from arrayfire/arrayfire-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharrayfire.interop.html
More file actions
185 lines (145 loc) · 7.57 KB
/
arrayfire.interop.html
File metadata and controls
185 lines (145 loc) · 7.57 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>arrayfire.interop module — ArrayFire Python documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-arrayfire.interop">
<span id="arrayfire-interop-module"></span><h1>arrayfire.interop module<a class="headerlink" href="#module-arrayfire.interop" title="Permalink to this headline">¶</a></h1>
<p>Interop with other python packages.</p>
<p>This module provides helper functions to copy data to arrayfire from the following modules:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>numpy - numpy.ndarray</p></li>
<li><p>pycuda - pycuda.gpuarray</p></li>
<li><p>pyopencl - pyopencl.array</p></li>
<li><p>numba - numba.cuda.cudadrv.devicearray.DeviceNDArray</p></li>
</ol>
</div></blockquote>
<dl class="py function">
<dt id="arrayfire.interop.from_ndarray">
<code class="sig-prename descclassname"><span class="pre">arrayfire.interop.</span></code><code class="sig-name descname"><span class="pre">from_ndarray</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">np_arr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arrayfire.interop.from_ndarray" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert numpy.ndarray to arrayfire.Array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>np_arr</strong><span class="classifier">numpy.ndarray()</span></dt><dd></dd>
<dt><strong>copy</strong><span class="classifier">Bool specifying if array is to be copied.</span></dt><dd><p>Default is true.
Can only be False if array is fortran contiguous.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>af_arr</strong><span class="classifier">arrayfire.Array()</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.interop.np_to_af_array">
<code class="sig-prename descclassname"><span class="pre">arrayfire.interop.</span></code><code class="sig-name descname"><span class="pre">np_to_af_array</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">np_arr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/interop.html#np_to_af_array"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.interop.np_to_af_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert numpy.ndarray to arrayfire.Array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>np_arr</strong><span class="classifier">numpy.ndarray()</span></dt><dd></dd>
<dt><strong>copy</strong><span class="classifier">Bool specifying if array is to be copied.</span></dt><dd><p>Default is true.
Can only be False if array is fortran contiguous.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>af_arr</strong><span class="classifier">arrayfire.Array()</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="arrayfire.interop.to_array">
<code class="sig-prename descclassname"><span class="pre">arrayfire.interop.</span></code><code class="sig-name descname"><span class="pre">to_array</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">in_array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/arrayfire/interop.html#to_array"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arrayfire.interop.to_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function to convert input from a different module to af.Array</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>in_array</strong><span class="classifier">array like object</span></dt><dd><p>Can be one of the following:
- numpy.ndarray
- pycuda.GPUArray
- pyopencl.Array
- numba.cuda.cudadrv.devicearray.DeviceNDArray
- array.array
- list</p>
</dd>
<dt><strong>copy</strong><span class="classifier">Bool specifying if array is to be copied.</span></dt><dd><p>Default is true.
Can only be False if array is fortran contiguous.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>af.Array of same dimensions as input after copying the data from the input</dt><dd></dd>
</dl>
</dd>
</dl>
</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>
<h1 class="logo"><a href="index.html">ArrayFire</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2020, ArrayFire.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/arrayfire.interop.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>