blob: dbff4889db94d5f2a120f977d6f09329fbea404d [file] [log] [blame]
<!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">
<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"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::common::random::RandGenerator&lt; gpu, DType &gt; Class Template 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="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>
<link href="doxygen.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">mxnet
</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>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1common.html">common</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1common_1_1random.html">random</a></li><li class="navelem"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html">RandGenerator&lt; gpu, DType &gt;</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::common::random::RandGenerator&lt; gpu, DType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="random__generator_8h_source.html">random_generator.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::common::random::RandGenerator&lt; gpu, DType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4__coll__graph.png" border="0" usemap="#mxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4_1_1Impl.html">Impl</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:acda2839fbe97d1f782d92033a5b47ff8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html#acda2839fbe97d1f782d92033a5b47ff8">Seed</a> (<a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> &gt; *s, uint32_t seed)</td></tr>
<tr class="separator:acda2839fbe97d1f782d92033a5b47ff8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f62d9ad0d6d43825af53656827b33f0"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html#a7f62d9ad0d6d43825af53656827b33f0">GetStates</a> ()</td></tr>
<tr class="separator:a7f62d9ad0d6d43825af53656827b33f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a26daf3daa7c4828422b95347d940a4a9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html#a26daf3daa7c4828422b95347d940a4a9">AllocState</a> (<a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt; *inst)</td></tr>
<tr class="separator:a26daf3daa7c4828422b95347d940a4a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d8f90c3bc95bf05a57d175afcd2700e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html#a4d8f90c3bc95bf05a57d175afcd2700e">FreeState</a> (<a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt; *inst)</td></tr>
<tr class="separator:a4d8f90c3bc95bf05a57d175afcd2700e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a38fd552186f00f675dcbd4cd078c0fec"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html#a38fd552186f00f675dcbd4cd078c0fec">kMinNumRandomPerThread</a></td></tr>
<tr class="separator:a38fd552186f00f675dcbd4cd078c0fec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bde74501b0cbece03e983354f3453c7"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4.html#a3bde74501b0cbece03e983354f3453c7">kNumRandomStates</a></td></tr>
<tr class="separator:a3bde74501b0cbece03e983354f3453c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a26daf3daa7c4828422b95347d940a4a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26daf3daa7c4828422b95347d940a4a9">&#9670;&nbsp;</a></span>AllocState()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">mxnet::common::random::RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt;::AllocState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt; *&#160;</td>
<td class="paramname"><em>inst</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4d8f90c3bc95bf05a57d175afcd2700e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d8f90c3bc95bf05a57d175afcd2700e">&#9670;&nbsp;</a></span>FreeState()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">mxnet::common::random::RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt;::FreeState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt; *&#160;</td>
<td class="paramname"><em>inst</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7f62d9ad0d6d43825af53656827b33f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f62d9ad0d6d43825af53656827b33f0">&#9670;&nbsp;</a></span>GetStates()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">mxnet::common::random::RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt;::GetStates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acda2839fbe97d1f782d92033a5b47ff8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acda2839fbe97d1f782d92033a5b47ff8">&#9670;&nbsp;</a></span>Seed()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">mxnet::common::random::RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt;::Seed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">mshadow::Stream</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> &gt; *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>seed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a38fd552186f00f675dcbd4cd078c0fec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38fd552186f00f675dcbd4cd078c0fec">&#9670;&nbsp;</a></span>kMinNumRandomPerThread</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">mxnet::common::random::RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt;::kMinNumRandomPerThread</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3bde74501b0cbece03e983354f3453c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bde74501b0cbece03e983354f3453c7">&#9670;&nbsp;</a></span>kNumRandomStates</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="classmxnet_1_1common_1_1random_1_1RandGenerator.html">mxnet::common::random::RandGenerator</a>&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a>, DType &gt;::kNumRandomStates</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/<a class="el" href="random__generator_8h_source.html">random_generator.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>