phasicFlow/doc/code-documentation/html/classpFlow_1_1uniformRandom...

399 lines
20 KiB
HTML

<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>PhasicFlow: uniformRandomInt32 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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classpFlow_1_1uniformRandomInt32.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classpFlow_1_1uniformRandomInt32-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uniformRandomInt32 Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af0cbc29c2a58a7f8cf48947bc89ba5ec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#af0cbc29c2a58a7f8cf48947bc89ba5ec">TypeInfoNV</a> (&quot;uniform&quot;)</td></tr>
<tr class="separator:af0cbc29c2a58a7f8cf48947bc89ba5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ab5d28189717af911b941a5d8fbe071"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#a1ab5d28189717af911b941a5d8fbe071">uniformRandomInt32</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> <a class="el" href="namespacepFlow.html#aba2f2ccdd3d4a6b403a2c2d379198396">min</a>, <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> <a class="el" href="namespacepFlow.html#ae14bf16748b3144baa1112f08c2a83b1">max</a>)</td></tr>
<tr class="separator:a1ab5d28189717af911b941a5d8fbe071"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c2c63ffcc1f53d6794e99fb59133c92"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#a8c2c63ffcc1f53d6794e99fb59133c92">~uniformRandomInt32</a> ()=default</td></tr>
<tr class="separator:a8c2c63ffcc1f53d6794e99fb59133c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ca351436b8555e1be5d195fffc463d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#a5ca351436b8555e1be5d195fffc463d4">randomNumber</a> ()</td></tr>
<tr class="separator:a5ca351436b8555e1be5d195fffc463d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac428a1f6db4c09b669a5487ee1413a2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a51afbafe3e3517b4e7755c14959053df">int32x3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#ac428a1f6db4c09b669a5487ee1413a2b">randomNumber3</a> ()</td></tr>
<tr class="separator:ac428a1f6db4c09b669a5487ee1413a2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0c3cbebb6fa42cfcd6dde7cf839b692"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#ad0c3cbebb6fa42cfcd6dde7cf839b692">operator()</a> ()</td></tr>
<tr class="separator:ad0c3cbebb6fa42cfcd6dde7cf839b692"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9ee2a5140d88d22da43754bc1faf33a2"><td class="memItemLeft" align="right" valign="top">std::mt19937_64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#a9ee2a5140d88d22da43754bc1faf33a2">engineGen_</a></td></tr>
<tr class="separator:a9ee2a5140d88d22da43754bc1faf33a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a100fe746d6fccb8ecca43582a79c4eb1"><td class="memItemLeft" align="right" valign="top">std::uniform_int_distribution&lt; <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1uniformRandomInt32.html#a100fe746d6fccb8ecca43582a79c4eb1">distrbution_</a></td></tr>
<tr class="separator:a100fe746d6fccb8ecca43582a79c4eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00032">32</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1ab5d28189717af911b941a5d8fbe071"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ab5d28189717af911b941a5d8fbe071">&#9670;&nbsp;</a></span>uniformRandomInt32()</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="classpFlow_1_1uniformRandomInt32.html">uniformRandomInt32</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&#160;</td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&#160;</td>
<td class="paramname"><em>max</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00045">45</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
</div>
</div>
<a id="a8c2c63ffcc1f53d6794e99fb59133c92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c2c63ffcc1f53d6794e99fb59133c92">&#9670;&nbsp;</a></span>~uniformRandomInt32()</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="classpFlow_1_1uniformRandomInt32.html">uniformRandomInt32</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af0cbc29c2a58a7f8cf48947bc89ba5ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0cbc29c2a58a7f8cf48947bc89ba5ec">&#9670;&nbsp;</a></span>TypeInfoNV()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TypeInfoNV </td>
<td>(</td>
<td class="paramtype">&quot;uniform&quot;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5ca351436b8555e1be5d195fffc463d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ca351436b8555e1be5d195fffc463d4">&#9670;&nbsp;</a></span>randomNumber()</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="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> randomNumber </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00053">53</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
<p class="reference">References <a class="el" href="uniformRandomInt32_8hpp_source.html#l00038">uniformRandomInt32::distrbution_</a>, and <a class="el" href="uniformRandomInt32_8hpp_source.html#l00036">uniformRandomInt32::engineGen_</a>.</p>
<p class="reference">Referenced by <a class="el" href="uniformRandomInt32_8hpp_source.html#l00068">uniformRandomInt32::operator()()</a>, <a class="el" href="uniformRandomInt32_8hpp_source.html#l00058">uniformRandomInt32::randomNumber3()</a>, and <a class="el" href="selectRandom_8cpp_source.html#l00028">selectRandom::selectAllPointsInRange()</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1uniformRandomInt32_a5ca351436b8555e1be5d195fffc463d4_icgraph.png" border="0" usemap="#classpFlow_1_1uniformRandomInt32_a5ca351436b8555e1be5d195fffc463d4_icgraph" alt=""/></div>
<map name="classpFlow_1_1uniformRandomInt32_a5ca351436b8555e1be5d195fffc463d4_icgraph" id="classpFlow_1_1uniformRandomInt32_a5ca351436b8555e1be5d195fffc463d4_icgraph">
<area shape="rect" title=" " alt="" coords="232,56,356,83"/>
<area shape="rect" href="classpFlow_1_1uniformRandomInt32.html#ad0c3cbebb6fa42cfcd6dde7cf839b692" title=" " alt="" coords="51,5,138,32"/>
<area shape="rect" href="classpFlow_1_1uniformRandomInt32.html#ac428a1f6db4c09b669a5487ee1413a2b" title=" " alt="" coords="29,56,161,83"/>
<area shape="rect" href="classpFlow_1_1selectRandom.html#af9905b10620776e3b5a42f779a83d503" title=" " alt="" coords="5,107,184,149"/>
</map>
</div>
</div>
</div>
<a id="ac428a1f6db4c09b669a5487ee1413a2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac428a1f6db4c09b669a5487ee1413a2b">&#9670;&nbsp;</a></span>randomNumber3()</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="namespacepFlow.html#a51afbafe3e3517b4e7755c14959053df">int32x3</a> randomNumber3 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00058">58</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
<p class="reference">References <a class="el" href="uniformRandomInt32_8hpp_source.html#l00053">uniformRandomInt32::randomNumber()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1uniformRandomInt32_ac428a1f6db4c09b669a5487ee1413a2b_cgraph.png" border="0" usemap="#classpFlow_1_1uniformRandomInt32_ac428a1f6db4c09b669a5487ee1413a2b_cgraph" alt=""/></div>
<map name="classpFlow_1_1uniformRandomInt32_ac428a1f6db4c09b669a5487ee1413a2b_cgraph" id="classpFlow_1_1uniformRandomInt32_ac428a1f6db4c09b669a5487ee1413a2b_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,137,32"/>
<area shape="rect" href="classpFlow_1_1uniformRandomInt32.html#a5ca351436b8555e1be5d195fffc463d4" title=" " alt="" coords="185,5,309,32"/>
</map>
</div>
</div>
</div>
<a id="ad0c3cbebb6fa42cfcd6dde7cf839b692"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0c3cbebb6fa42cfcd6dde7cf839b692">&#9670;&nbsp;</a></span>operator()()</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="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> operator() </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00068">68</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
<p class="reference">References <a class="el" href="uniformRandomInt32_8hpp_source.html#l00053">uniformRandomInt32::randomNumber()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classpFlow_1_1uniformRandomInt32_ad0c3cbebb6fa42cfcd6dde7cf839b692_cgraph.png" border="0" usemap="#classpFlow_1_1uniformRandomInt32_ad0c3cbebb6fa42cfcd6dde7cf839b692_cgraph" alt=""/></div>
<map name="classpFlow_1_1uniformRandomInt32_ad0c3cbebb6fa42cfcd6dde7cf839b692_cgraph" id="classpFlow_1_1uniformRandomInt32_ad0c3cbebb6fa42cfcd6dde7cf839b692_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,92,32"/>
<area shape="rect" href="classpFlow_1_1uniformRandomInt32.html#a5ca351436b8555e1be5d195fffc463d4" title=" " alt="" coords="140,5,264,32"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9ee2a5140d88d22da43754bc1faf33a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ee2a5140d88d22da43754bc1faf33a2">&#9670;&nbsp;</a></span>engineGen_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::mt19937_64 engineGen_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00036">36</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="uniformRandomInt32_8hpp_source.html#l00053">uniformRandomInt32::randomNumber()</a>.</p>
</div>
</div>
<a id="a100fe746d6fccb8ecca43582a79c4eb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a100fe746d6fccb8ecca43582a79c4eb1">&#9670;&nbsp;</a></span>distrbution_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::uniform_int_distribution&lt;<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&gt; distrbution_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="uniformRandomInt32_8hpp_source.html#l00038">38</a> of file <a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="uniformRandomInt32_8hpp_source.html#l00053">uniformRandomInt32::randomNumber()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/phasicFlow/random/randomInt32/<a class="el" href="uniformRandomInt32_8hpp_source.html">uniformRandomInt32.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1uniformRandomInt32.html">uniformRandomInt32</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>