blob: 85493aefc833de94ff99436392fc5247d59a0112 [file] [log] [blame]
<!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.6" name="generator"/>
<title>mxnet: mxnet::common::random::RandGenerator&lt; gpu, DType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script src="jquery.js" type="text/javascript"></script>
<script src="dynsections.js" type="text/javascript"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script src="search/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 cellpadding="0" cellspacing="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div class="tabs" id="navrow1">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div class="MSearchBoxInactive" id="MSearchBox">
<span class="left">
<img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/>
<input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/>
</span><span class="right">
<a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2" id="navrow2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
<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> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<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 alt="Collaboration graph" border="0" src="classmxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4__coll__graph.png" usemap="#mxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4_coll__map"/></div>
<map id="mxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4_coll__map" name="mxnet_1_1common_1_1random_1_1RandGenerator_3_01gpu_00_01DType_01_4_coll__map">
</map>
</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 align="right" class="memItemLeft" valign="top">class  </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"> </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 align="right" class="memItemLeft" valign="top">void </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> (mshadow::Stream&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"> </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 align="right" class="memItemLeft" valign="top">static void </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"> </td></tr>
<tr class="memitem:a4d8f90c3bc95bf05a57d175afcd2700e"><td align="right" class="memItemLeft" valign="top">static void </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"> </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 align="right" class="memItemLeft" valign="top">static const int </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"> </td></tr>
<tr class="memitem:a3bde74501b0cbece03e983354f3453c7"><td align="right" class="memItemLeft" valign="top">static const int </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"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a26daf3daa7c4828422b95347d940a4a9"></a>
<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; * </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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4d8f90c3bc95bf05a57d175afcd2700e"></a>
<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; * </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">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acda2839fbe97d1f782d92033a5b47ff8"></a>
<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">mshadow::Stream&lt; <a class="el" href="namespacemxnet.html#a31ef33571a4f6ba8847eeee1f4907141">gpu</a> &gt; * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>seed</em> </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 class="anchor" id="a38fd552186f00f675dcbd4cd078c0fec"></a>
<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 class="anchor" id="a3bde74501b0cbece03e983354f3453c7"></a>
<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>src/common/<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 Feb 22 2018 19:36:05 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.6
</small></address>
</body>
</html>