-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassaf_1_1randomEngine.htm
More file actions
422 lines (390 loc) · 24.8 KB
/
classaf_1_1randomEngine.htm
File metadata and controls
422 lines (390 loc) · 24.8 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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<!-- HTML header for doxygen 1.9.5-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-130950618-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-130950618-1');
</script>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArrayFire: randomEngine Class Reference</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="arrayfire.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeFragmentCopyButton.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="2" cellpadding="2" width="100%">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><a href="index.htm"><img alt="Logo" src="arrayfire_logo.png"/></a></td>
</tr>
<tr id="projectrow">
<td>
<div id="projectbrief">A high-performance general-purpose compute library</div>
</td>
</tr>
<!--END !PROJECT_NAME-->
<div>
<td id="gsearch">
<script async src="https://cse.google.com/cse.js?cx=004356362924927882526:zup3ehe-7bs"></script>
<div class="gcse-search"></div>
</td>
</div>
</tr>
<tr>
<td>
<div id="togglediv"></div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part --><!-- Generated by Doxygen 1.9.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="tutorials.htm"><span>Tutorials</span></a></li>
<li><a href="modules.htm"><span>Functions</span></a></li>
<li><a href="releasenotes.htm"><span>Release Notes</span></a></li>
<li><a href="examples.htm"><span>Examples</span></a></li>
</ul>
</div>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classaf_1_1randomEngine.htm',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle"><div class="title">randomEngine Class Reference<div class="ingroups"><a class="el" href="group__arrayfire__class.htm">ArrayFire Classes</a> | <a class="el" href="group__func__categories.htm">ArrayFire Functions by Category</a> » <a class="el" href="group__array__mat.htm">Functions to create and modify Arrays</a> » <a class="el" href="group__data__mat.htm">Functions to create arrays.</a> » <a class="el" href="group__random__mat.htm">Random Number Generation</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>C++ Interface - Random Number Generation Engine Class.
<a href="classaf_1_1randomEngine.htm#details">More...</a></p>
<p><code>#include <<a class="el" href="random_8h_source.htm">random.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a99fc623c5e3483dcfda957d67347086f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#a99fc623c5e3483dcfda957d67347086f">randomEngine</a> (<a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934">randomEngineType</a> typeIn=<a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934a4e97cf0c58621f4ce0cfcb95a916a0ec">AF_RANDOM_ENGINE_DEFAULT</a>, unsigned long long seedIn=0)</td></tr>
<tr class="memdesc:a99fc623c5e3483dcfda957d67347086f"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to create a <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a> object with a <a class="el" href="namespaceaf.htm#aaa341d395616c73f5a587c8586e25115">af::randomEngineType</a> and a seed. <a href="classaf_1_1randomEngine.htm#a99fc623c5e3483dcfda957d67347086f">More...</a><br /></td></tr>
<tr class="separator:a99fc623c5e3483dcfda957d67347086f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec5b8514ac44e14e59c27f078cfc90ea"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#aec5b8514ac44e14e59c27f078cfc90ea">randomEngine</a> (const <a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> &other)</td></tr>
<tr class="memdesc:aec5b8514ac44e14e59c27f078cfc90ea"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface copy constructor for a <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a>. <a href="classaf_1_1randomEngine.htm#aec5b8514ac44e14e59c27f078cfc90ea">More...</a><br /></td></tr>
<tr class="separator:aec5b8514ac44e14e59c27f078cfc90ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad98c06f412ceaae25f988c745f8401e7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#ad98c06f412ceaae25f988c745f8401e7">randomEngine</a> (<a class="el" href="group__random__mat.htm#gae28b4b802cfbb69cfac63c9e5936f508">af_random_engine</a> engine)</td></tr>
<tr class="memdesc:ad98c06f412ceaae25f988c745f8401e7"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to create a copy of the random engine object from a <a class="el" href="group__random__mat.htm#gae28b4b802cfbb69cfac63c9e5936f508">af_random_engine</a> handle. <a href="classaf_1_1randomEngine.htm#ad98c06f412ceaae25f988c745f8401e7">More...</a><br /></td></tr>
<tr class="separator:ad98c06f412ceaae25f988c745f8401e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe76757bae32139d3a6ebec26713e123"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#afe76757bae32139d3a6ebec26713e123">~randomEngine</a> ()</td></tr>
<tr class="memdesc:afe76757bae32139d3a6ebec26713e123"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface destructor for a <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a>. <a href="classaf_1_1randomEngine.htm#afe76757bae32139d3a6ebec26713e123">More...</a><br /></td></tr>
<tr class="separator:afe76757bae32139d3a6ebec26713e123"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ee437e84414e7c9a9da00d31d6f33a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#a8ee437e84414e7c9a9da00d31d6f33a3">operator=</a> (const <a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> &other)</td></tr>
<tr class="memdesc:a8ee437e84414e7c9a9da00d31d6f33a3"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to assign the internal state of randome engine. <a href="classaf_1_1randomEngine.htm#a8ee437e84414e7c9a9da00d31d6f33a3">More...</a><br /></td></tr>
<tr class="separator:a8ee437e84414e7c9a9da00d31d6f33a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c8a2102ac5e30114630b0a494b5992b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#a7c8a2102ac5e30114630b0a494b5992b">setType</a> (const <a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934">randomEngineType</a> type)</td></tr>
<tr class="memdesc:a7c8a2102ac5e30114630b0a494b5992b"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to set the random type of the random engine. <a href="classaf_1_1randomEngine.htm#a7c8a2102ac5e30114630b0a494b5992b">More...</a><br /></td></tr>
<tr class="separator:a7c8a2102ac5e30114630b0a494b5992b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f5b63ccf8a707bf84ecd7fa3a7f75da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934">randomEngineType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#a2f5b63ccf8a707bf84ecd7fa3a7f75da">getType</a> (void)</td></tr>
<tr class="memdesc:a2f5b63ccf8a707bf84ecd7fa3a7f75da"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to get the random type of the random engine. <a href="classaf_1_1randomEngine.htm#a2f5b63ccf8a707bf84ecd7fa3a7f75da">More...</a><br /></td></tr>
<tr class="separator:a2f5b63ccf8a707bf84ecd7fa3a7f75da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ff18bca1ef670e444c8b17861cd95c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#a4ff18bca1ef670e444c8b17861cd95c1">setSeed</a> (const unsigned long long seed)</td></tr>
<tr class="memdesc:a4ff18bca1ef670e444c8b17861cd95c1"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to set the seed of the random engine. <a href="classaf_1_1randomEngine.htm#a4ff18bca1ef670e444c8b17861cd95c1">More...</a><br /></td></tr>
<tr class="separator:a4ff18bca1ef670e444c8b17861cd95c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5097cda0eb389cefbbf3042304de86f9"><td class="memItemLeft" align="right" valign="top">unsigned long long </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#a5097cda0eb389cefbbf3042304de86f9">getSeed</a> (void) const</td></tr>
<tr class="memdesc:a5097cda0eb389cefbbf3042304de86f9"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to return the seed of the random engine. <a href="classaf_1_1randomEngine.htm#a5097cda0eb389cefbbf3042304de86f9">More...</a><br /></td></tr>
<tr class="separator:a5097cda0eb389cefbbf3042304de86f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa0d597dca862f2c65692ebc43d3b1dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__random__mat.htm#gae28b4b802cfbb69cfac63c9e5936f508">af_random_engine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1randomEngine.htm#afa0d597dca862f2c65692ebc43d3b1dc">get</a> (void) const</td></tr>
<tr class="memdesc:afa0d597dca862f2c65692ebc43d3b1dc"><td class="mdescLeft"> </td><td class="mdescRight">C++ Interface to return the af_random_engine handle of this object. <a href="classaf_1_1randomEngine.htm#afa0d597dca862f2c65692ebc43d3b1dc">More...</a><br /></td></tr>
<tr class="separator:afa0d597dca862f2c65692ebc43d3b1dc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >C++ Interface - Random Number Generation Engine Class. </p>
<p >The <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a> class is used to set the type and seed of random number generation engine based on <a class="el" href="namespaceaf.htm#aaa341d395616c73f5a587c8586e25115">af::randomEngineType</a>. </p>
<p class="definition">Definition at line <a class="el" href="random_8h_source.htm#l00034">34</a> of file <a class="el" href="random_8h_source.htm">random.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a99fc623c5e3483dcfda957d67347086f" name="a99fc623c5e3483dcfda957d67347086f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99fc623c5e3483dcfda957d67347086f">◆ </a></span>randomEngine() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934">randomEngineType</a> </td>
<td class="paramname"><em>typeIn</em> = <code><a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934a4e97cf0c58621f4ce0cfcb95a916a0ec">AF_RANDOM_ENGINE_DEFAULT</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long long </td>
<td class="paramname"><em>seedIn</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to create a <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a> object with a <a class="el" href="namespaceaf.htm#aaa341d395616c73f5a587c8586e25115">af::randomEngineType</a> and a seed. </p>
<div class="fragment"><div class="line"><span class="comment">// create a random engine of default type with seed = 1</span></div>
<div class="line"><a class="code hl_class" href="classaf_1_1randomEngine.htm">randomEngine</a> r(<a class="code hl_enumvalue" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934a4e97cf0c58621f4ce0cfcb95a916a0ec">AF_RANDOM_ENGINE_DEFAULT</a>, 1);</div>
<div class="ttc" id="aclassaf_1_1randomEngine_htm"><div class="ttname"><a href="classaf_1_1randomEngine.htm">af::randomEngine</a></div><div class="ttdoc">C++ Interface - Random Number Generation Engine Class.</div><div class="ttdef"><b>Definition:</b> <a href="random_8h_source.htm#l00034">random.h:34</a></div></div>
<div class="ttc" id="adefines_8h_htm_a82a3bf91d6dd04661c63632d0fbf4934a4e97cf0c58621f4ce0cfcb95a916a0ec"><div class="ttname"><a href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934a4e97cf0c58621f4ce0cfcb95a916a0ec">AF_RANDOM_ENGINE_DEFAULT</a></div><div class="ttdeci">@ AF_RANDOM_ENGINE_DEFAULT</div><div class="ttdef"><b>Definition:</b> <a href="defines_8h_source.htm#l00450">defines.h:449</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aec5b8514ac44e14e59c27f078cfc90ea" name="aec5b8514ac44e14e59c27f078cfc90ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec5b8514ac44e14e59c27f078cfc90ea">◆ </a></span>randomEngine() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface copy constructor for a <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>input random engine object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad98c06f412ceaae25f988c745f8401e7" name="ad98c06f412ceaae25f988c745f8401e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad98c06f412ceaae25f988c745f8401e7">◆ </a></span>randomEngine() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__random__mat.htm#gae28b4b802cfbb69cfac63c9e5936f508">af_random_engine</a> </td>
<td class="paramname"><em>engine</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to create a copy of the random engine object from a <a class="el" href="group__random__mat.htm#gae28b4b802cfbb69cfac63c9e5936f508">af_random_engine</a> handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">engine</td><td>The input random engine object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afe76757bae32139d3a6ebec26713e123" name="afe76757bae32139d3a6ebec26713e123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe76757bae32139d3a6ebec26713e123">◆ </a></span>~randomEngine()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface destructor for a <a class="el" href="classaf_1_1randomEngine.htm">af::randomEngine</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afa0d597dca862f2c65692ebc43d3b1dc" name="afa0d597dca862f2c65692ebc43d3b1dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa0d597dca862f2c65692ebc43d3b1dc">◆ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__random__mat.htm#gae28b4b802cfbb69cfac63c9e5936f508">af_random_engine</a> get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to return the af_random_engine handle of this object. </p>
<dl class="section return"><dt>Returns</dt><dd>handle to the af_random_engine associated with this random engine </dd></dl>
</div>
</div>
<a id="a5097cda0eb389cefbbf3042304de86f9" name="a5097cda0eb389cefbbf3042304de86f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5097cda0eb389cefbbf3042304de86f9">◆ </a></span>getSeed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long long getSeed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to return the seed of the random engine. </p>
<dl class="section return"><dt>Returns</dt><dd>seed associated with random engine </dd></dl>
</div>
</div>
<a id="a2f5b63ccf8a707bf84ecd7fa3a7f75da" name="a2f5b63ccf8a707bf84ecd7fa3a7f75da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f5b63ccf8a707bf84ecd7fa3a7f75da">◆ </a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934">randomEngineType</a> getType </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to get the random type of the random engine. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespaceaf.htm#aaa341d395616c73f5a587c8586e25115">af::randomEngineType</a> associated with random engine </dd></dl>
</div>
</div>
<a id="a8ee437e84414e7c9a9da00d31d6f33a3" name="a8ee437e84414e7c9a9da00d31d6f33a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ee437e84414e7c9a9da00d31d6f33a3">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> & operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to assign the internal state of randome engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>object to be assigned to the random engine</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the reference to this </dd></dl>
</div>
</div>
<a id="a4ff18bca1ef670e444c8b17861cd95c1" name="a4ff18bca1ef670e444c8b17861cd95c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ff18bca1ef670e444c8b17861cd95c1">◆ </a></span>setSeed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setSeed </td>
<td>(</td>
<td class="paramtype">const unsigned long long </td>
<td class="paramname"><em>seed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to set the seed of the random engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">seed</td><td>initializing seed of the random number generator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7c8a2102ac5e30114630b0a494b5992b" name="a7c8a2102ac5e30114630b0a494b5992b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c8a2102ac5e30114630b0a494b5992b">◆ </a></span>setType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="defines_8h.htm#a82a3bf91d6dd04661c63632d0fbf4934">randomEngineType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>C++ Interface to set the random type of the random engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>type of the random number generator </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="random_8h_source.htm">random.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.3-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceaf.htm">af</a></li><li class="navelem"><a class="el" href="classaf_1_1randomEngine.htm">randomEngine</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
</ul>
</div>
</body>
</html>