forked from arrayfire/arrayfire-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrandom.html
More file actions
334 lines (251 loc) · 28 KB
/
random.html
File metadata and controls
334 lines (251 loc) · 28 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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>arrayfire.random — 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">
<h1>Source code for arrayfire.random</h1><div class="highlight"><pre>
<span></span><span class="c1">#######################################################</span>
<span class="c1"># Copyright (c) 2015, ArrayFire</span>
<span class="c1"># All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># This file is distributed under 3-clause BSD license.</span>
<span class="c1"># The complete license agreement can be obtained at:</span>
<span class="c1"># http://arrayfire.com/licenses/BSD-3-Clause</span>
<span class="c1">########################################################</span>
<span class="sd">"""</span>
<span class="sd">Random engine class and functions to generate random numbers.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">.library</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">.array</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">import</span> <span class="nn">numbers</span>
<div class="viewcode-block" id="Random_Engine"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.Random_Engine">[docs]</a><span class="k">class</span> <span class="nc">Random_Engine</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Class to handle random number generator engines.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> engine_type : optional: RANDOME_ENGINE. default: RANDOM_ENGINE.PHILOX</span>
<span class="sd"> - Specifies the type of random engine to be created. Can be one of:</span>
<span class="sd"> - RANDOM_ENGINE.PHILOX_4X32_10</span>
<span class="sd"> - RANDOM_ENGINE.THREEFRY_2X32_16</span>
<span class="sd"> - RANDOM_ENGINE.MERSENNE_GP11213</span>
<span class="sd"> - RANDOM_ENGINE.PHILOX (same as RANDOM_ENGINE.PHILOX_4X32_10)</span>
<span class="sd"> - RANDOM_ENGINE.THREEFRY (same as RANDOM_ENGINE.THREEFRY_2X32_16)</span>
<span class="sd"> - RANDOM_ENGINE.DEFAULT</span>
<span class="sd"> - Not used if engine is not None</span>
<span class="sd"> seed : optional int. default: 0</span>
<span class="sd"> - Specifies the seed for the random engine</span>
<span class="sd"> - Not used if engine is not None</span>
<span class="sd"> engine : optional ctypes.c_void_p. default: None.</span>
<span class="sd"> - Used a handle created by the C api to create the Random_Engine.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">engine_type</span> <span class="o">=</span> <span class="n">RANDOM_ENGINE</span><span class="o">.</span><span class="n">PHILOX</span><span class="p">,</span> <span class="n">seed</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">engine</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="p">(</span><span class="n">engine</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">engine</span> <span class="o">=</span> <span class="n">c_void_ptr_t</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_create_random_engine</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">),</span> <span class="n">engine_type</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">c_longlong_t</span><span class="p">(</span><span class="n">seed</span><span class="p">)))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">engine</span> <span class="o">=</span> <span class="n">engine</span>
<span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_release_random_engine</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">))</span>
<div class="viewcode-block" id="Random_Engine.set_type"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.Random_Engine.set_type">[docs]</a> <span class="k">def</span> <span class="nf">set_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">engine_type</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the type of the random engine.</span>
<span class="sd"> """</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_random_engine_set_type</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">),</span> <span class="n">engine_type</span><span class="o">.</span><span class="n">value</span><span class="p">))</span></div>
<div class="viewcode-block" id="Random_Engine.get_type"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.Random_Engine.get_type">[docs]</a> <span class="k">def</span> <span class="nf">get_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get the type of the random engine.</span>
<span class="sd"> """</span>
<span class="n">__to_random_engine_type</span> <span class="o">=</span> <span class="p">[</span><span class="n">RANDOM_ENGINE</span><span class="o">.</span><span class="n">PHILOX_4X32_10</span><span class="p">,</span>
<span class="n">RANDOM_ENGINE</span><span class="o">.</span><span class="n">THREEFRY_2X32_16</span><span class="p">,</span>
<span class="n">RANDOM_ENGINE</span><span class="o">.</span><span class="n">MERSENNE_GP11213</span><span class="p">]</span>
<span class="n">rty</span> <span class="o">=</span> <span class="n">c_int_t</span><span class="p">(</span><span class="n">RANDOM_ENGINE</span><span class="o">.</span><span class="n">PHILOX</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_random_engine_get_type</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">rty</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">))</span>
<span class="k">return</span> <span class="n">__to_random_engine_type</span><span class="p">[</span><span class="n">rty</span><span class="p">]</span></div>
<div class="viewcode-block" id="Random_Engine.set_seed"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.Random_Engine.set_seed">[docs]</a> <span class="k">def</span> <span class="nf">set_seed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seed</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the seed for the random engine.</span>
<span class="sd"> """</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_random_engine_set_seed</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">),</span> <span class="n">c_longlong_t</span><span class="p">(</span><span class="n">seed</span><span class="p">)))</span></div>
<div class="viewcode-block" id="Random_Engine.get_seed"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.Random_Engine.get_seed">[docs]</a> <span class="k">def</span> <span class="nf">get_seed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get the seed for the random engine.</span>
<span class="sd"> """</span>
<span class="n">seed</span> <span class="o">=</span> <span class="n">c_longlong_t</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_random_engine_get_seed</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">seed</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">))</span>
<span class="k">return</span> <span class="n">seed</span><span class="o">.</span><span class="n">value</span></div></div>
<div class="viewcode-block" id="randu"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.randu">[docs]</a><span class="k">def</span> <span class="nf">randu</span><span class="p">(</span><span class="n">d0</span><span class="p">,</span> <span class="n">d1</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">d2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">d3</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">Dtype</span><span class="o">.</span><span class="n">f32</span><span class="p">,</span> <span class="n">engine</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a multi dimensional array containing values from a uniform distribution.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> d0 : int.</span>
<span class="sd"> Length of first dimension.</span>
<span class="sd"> d1 : optional: int. default: None.</span>
<span class="sd"> Length of second dimension.</span>
<span class="sd"> d2 : optional: int. default: None.</span>
<span class="sd"> Length of third dimension.</span>
<span class="sd"> d3 : optional: int. default: None.</span>
<span class="sd"> Length of fourth dimension.</span>
<span class="sd"> dtype : optional: af.Dtype. default: af.Dtype.f32.</span>
<span class="sd"> Data type of the array.</span>
<span class="sd"> engine : optional: Random_Engine. default: None.</span>
<span class="sd"> If engine is None, uses a default engine created by arrayfire.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> out : af.Array</span>
<span class="sd"> Multi dimensional array whose elements are sampled uniformly between [0, 1].</span>
<span class="sd"> - If d1 is None, `out` is 1D of size (d0,).</span>
<span class="sd"> - If d1 is not None and d2 is None, `out` is 2D of size (d0, d1).</span>
<span class="sd"> - If d1 and d2 are not None and d3 is None, `out` is 3D of size (d0, d1, d2).</span>
<span class="sd"> - If d1, d2, d3 are all not None, `out` is 4D of size (d0, d1, d2, d3).</span>
<span class="sd"> """</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">Array</span><span class="p">()</span>
<span class="n">dims</span> <span class="o">=</span> <span class="n">dim4</span><span class="p">(</span><span class="n">d0</span><span class="p">,</span> <span class="n">d1</span><span class="p">,</span> <span class="n">d2</span><span class="p">,</span> <span class="n">d3</span><span class="p">)</span>
<span class="k">if</span> <span class="n">engine</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_randu</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span> <span class="mi">4</span><span class="p">,</span> <span class="n">c_pointer</span><span class="p">(</span><span class="n">dims</span><span class="p">),</span> <span class="n">dtype</span><span class="o">.</span><span class="n">value</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_random_uniform</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span> <span class="mi">4</span><span class="p">,</span> <span class="n">c_pointer</span><span class="p">(</span><span class="n">dims</span><span class="p">),</span> <span class="n">dtype</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">engine</span><span class="o">.</span><span class="n">engine</span><span class="p">))</span>
<span class="k">return</span> <span class="n">out</span></div>
<div class="viewcode-block" id="randn"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.randn">[docs]</a><span class="k">def</span> <span class="nf">randn</span><span class="p">(</span><span class="n">d0</span><span class="p">,</span> <span class="n">d1</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">d2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">d3</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">Dtype</span><span class="o">.</span><span class="n">f32</span><span class="p">,</span> <span class="n">engine</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a multi dimensional array containing values from a normal distribution.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> d0 : int.</span>
<span class="sd"> Length of first dimension.</span>
<span class="sd"> d1 : optional: int. default: None.</span>
<span class="sd"> Length of second dimension.</span>
<span class="sd"> d2 : optional: int. default: None.</span>
<span class="sd"> Length of third dimension.</span>
<span class="sd"> d3 : optional: int. default: None.</span>
<span class="sd"> Length of fourth dimension.</span>
<span class="sd"> dtype : optional: af.Dtype. default: af.Dtype.f32.</span>
<span class="sd"> Data type of the array.</span>
<span class="sd"> engine : optional: Random_Engine. default: None.</span>
<span class="sd"> If engine is None, uses a default engine created by arrayfire.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> out : af.Array</span>
<span class="sd"> Multi dimensional array whose elements are sampled from a normal distribution with mean 0 and sigma of 1.</span>
<span class="sd"> - If d1 is None, `out` is 1D of size (d0,).</span>
<span class="sd"> - If d1 is not None and d2 is None, `out` is 2D of size (d0, d1).</span>
<span class="sd"> - If d1 and d2 are not None and d3 is None, `out` is 3D of size (d0, d1, d2).</span>
<span class="sd"> - If d1, d2, d3 are all not None, `out` is 4D of size (d0, d1, d2, d3).</span>
<span class="sd"> """</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">Array</span><span class="p">()</span>
<span class="n">dims</span> <span class="o">=</span> <span class="n">dim4</span><span class="p">(</span><span class="n">d0</span><span class="p">,</span> <span class="n">d1</span><span class="p">,</span> <span class="n">d2</span><span class="p">,</span> <span class="n">d3</span><span class="p">)</span>
<span class="k">if</span> <span class="n">engine</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_randn</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span> <span class="mi">4</span><span class="p">,</span> <span class="n">c_pointer</span><span class="p">(</span><span class="n">dims</span><span class="p">),</span> <span class="n">dtype</span><span class="o">.</span><span class="n">value</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_random_normal</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">arr</span><span class="p">),</span> <span class="mi">4</span><span class="p">,</span> <span class="n">c_pointer</span><span class="p">(</span><span class="n">dims</span><span class="p">),</span> <span class="n">dtype</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">engine</span><span class="o">.</span><span class="n">engine</span><span class="p">))</span>
<span class="k">return</span> <span class="n">out</span></div>
<div class="viewcode-block" id="set_seed"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.set_seed">[docs]</a><span class="k">def</span> <span class="nf">set_seed</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the seed for the random number generator.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> seed: int.</span>
<span class="sd"> Seed for the random number generator</span>
<span class="sd"> """</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_set_seed</span><span class="p">(</span><span class="n">c_ulonglong_t</span><span class="p">(</span><span class="n">seed</span><span class="p">)))</span></div>
<div class="viewcode-block" id="get_seed"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.get_seed">[docs]</a><span class="k">def</span> <span class="nf">get_seed</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Get the seed for the random number generator.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> seed: int.</span>
<span class="sd"> Seed for the random number generator</span>
<span class="sd"> """</span>
<span class="n">seed</span> <span class="o">=</span> <span class="n">c_ulonglong_t</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_get_seed</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">seed</span><span class="p">)))</span>
<span class="k">return</span> <span class="n">seed</span><span class="o">.</span><span class="n">value</span></div>
<div class="viewcode-block" id="set_default_random_engine_type"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.set_default_random_engine_type">[docs]</a><span class="k">def</span> <span class="nf">set_default_random_engine_type</span><span class="p">(</span><span class="n">engine_type</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set random engine type for default random engine.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> engine_type : RANDOME_ENGINE.</span>
<span class="sd"> - Specifies the type of random engine to be created. Can be one of:</span>
<span class="sd"> - RANDOM_ENGINE.PHILOX_4X32_10</span>
<span class="sd"> - RANDOM_ENGINE.THREEFRY_2X32_16</span>
<span class="sd"> - RANDOM_ENGINE.MERSENNE_GP11213</span>
<span class="sd"> - RANDOM_ENGINE.PHILOX (same as RANDOM_ENGINE.PHILOX_4X32_10)</span>
<span class="sd"> - RANDOM_ENGINE.THREEFRY (same as RANDOM_ENGINE.THREEFRY_2X32_16)</span>
<span class="sd"> - RANDOM_ENGINE.DEFAULT</span>
<span class="sd"> Note</span>
<span class="sd"> ----</span>
<span class="sd"> This only affects randu and randn when a random engine is not specified.</span>
<span class="sd"> """</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_set_default_random_engine_type</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">),</span> <span class="n">engine_type</span><span class="o">.</span><span class="n">value</span><span class="p">))</span></div>
<div class="viewcode-block" id="get_default_random_engine"><a class="viewcode-back" href="../../arrayfire.random.html#arrayfire.random.get_default_random_engine">[docs]</a><span class="k">def</span> <span class="nf">get_default_random_engine</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Get the default random engine</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> The default random engine used by randu and randn</span>
<span class="sd"> """</span>
<span class="n">engine</span> <span class="o">=</span> <span class="n">c_void_ptr_t</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">default_engine</span> <span class="o">=</span> <span class="n">c_void_ptr_t</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_get_default_random_engine</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">default_engine</span><span class="p">)))</span>
<span class="n">safe_call</span><span class="p">(</span><span class="n">backend</span><span class="o">.</span><span class="n">get</span><span class="p">()</span><span class="o">.</span><span class="n">af_retain_random_engine</span><span class="p">(</span><span class="n">c_pointer</span><span class="p">(</span><span class="n">engine</span><span class="p">),</span> <span class="n">default_engine</span><span class="p">))</span>
<span class="k">return</span> <span class="n">Random_Engine</span><span class="p">(</span><span class="n">engine</span><span class="o">=</span><span class="n">engine</span><span class="p">)</span></div>
</pre></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>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</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>
</div>
</body>
</html>