blob: f427747db3eb0473237a5ddda5888d6b73b3f26a [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 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mshadow::Random&lt; cpu, 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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="namespacemshadow.html">mshadow</a></li><li class="navelem"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html">Random&lt; cpu, DType &gt;</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mshadow::Random&lt; cpu, DType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>CPU random number generator.
<a href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="random_8h_source.html">random.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mshadow::Random&lt; cpu, DType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmshadow_1_1Random_3_01cpu_00_01DType_01_4__coll__graph.png" border="0" usemap="#mshadow_1_1Random_3_01cpu_00_01DType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mshadow_1_1Random_3_01cpu_00_01DType_01_4_coll__map" id="mshadow_1_1Random_3_01cpu_00_01DType_01_4_coll__map">
</map>
</div>
<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:a468829a8a58919ec4aadb1e75a6174ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a468829a8a58919ec4aadb1e75a6174ff">Random</a> (int seed)</td></tr>
<tr class="memdesc:a468829a8a58919ec4aadb1e75a6174ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor of random engine <a href="#a468829a8a58919ec4aadb1e75a6174ff">More...</a><br /></td></tr>
<tr class="separator:a468829a8a58919ec4aadb1e75a6174ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37b7e8cbe08d7c0f6699039cc0bad8b2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a37b7e8cbe08d7c0f6699039cc0bad8b2">~Random</a> (void)</td></tr>
<tr class="separator:a37b7e8cbe08d7c0f6699039cc0bad8b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff2ec8923288cea076f5fa94897c0bfe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#aff2ec8923288cea076f5fa94897c0bfe">Seed</a> (int seed)</td></tr>
<tr class="memdesc:aff2ec8923288cea076f5fa94897c0bfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">seed random number generator using this seed <a href="#aff2ec8923288cea076f5fa94897c0bfe">More...</a><br /></td></tr>
<tr class="separator:aff2ec8923288cea076f5fa94897c0bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41b3d2a322bbd6fc2679275b80c27342"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a41b3d2a322bbd6fc2679275b80c27342">GetSeed</a> () const</td></tr>
<tr class="memdesc:a41b3d2a322bbd6fc2679275b80c27342"><td class="mdescLeft">&#160;</td><td class="mdescRight">get random seed used in random generator <a href="#a41b3d2a322bbd6fc2679275b80c27342">More...</a><br /></td></tr>
<tr class="separator:a41b3d2a322bbd6fc2679275b80c27342"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0096231388917db869409e0f587b1cf3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a0096231388917db869409e0f587b1cf3">set_stream</a> (<a class="el" href="structmshadow_1_1Stream.html">Stream</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a> &gt; *stream)</td></tr>
<tr class="memdesc:a0096231388917db869409e0f587b1cf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the stream of computation <a href="#a0096231388917db869409e0f587b1cf3">More...</a><br /></td></tr>
<tr class="separator:a0096231388917db869409e0f587b1cf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ca9b27ca3752795017372a05cfce5c3"><td class="memTemplParams" colspan="2">template&lt;int dim&gt; </td></tr>
<tr class="memitem:a4ca9b27ca3752795017372a05cfce5c3"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1expr_1_1ReshapeExp.html">expr::ReshapeExp</a>&lt; <a class="el" href="structmshadow_1_1Tensor.html">Tensor</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, 1, DType &gt;, DType, dim, 1 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a4ca9b27ca3752795017372a05cfce5c3">gaussian</a> (<a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; dim &gt; shape)</td></tr>
<tr class="memdesc:a4ca9b27ca3752795017372a05cfce5c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">return a temporal expression storing standard gaussian random variables the temporal tensor is only valid before next call of gaussian or uniform can be used as part of expression Caution: this means expression such as A = gaussian(s1) * gaussian(s2) will give invalid result, since second call of gaussian(s2) makes gaussian(s1) invalid A = gaussian(s1)*B+C; is correct; use one gaussian/uniform in each expression <a href="#a4ca9b27ca3752795017372a05cfce5c3">More...</a><br /></td></tr>
<tr class="separator:a4ca9b27ca3752795017372a05cfce5c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4eae04b06525d65b839f2c9c5428c436"><td class="memTemplParams" colspan="2">template&lt;int dim&gt; </td></tr>
<tr class="memitem:a4eae04b06525d65b839f2c9c5428c436"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structmshadow_1_1expr_1_1ReshapeExp.html">expr::ReshapeExp</a>&lt; <a class="el" href="structmshadow_1_1Tensor.html">Tensor</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, 1, DType &gt;, DType, dim, 1 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a4eae04b06525d65b839f2c9c5428c436">uniform</a> (<a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; dim &gt; shape)</td></tr>
<tr class="memdesc:a4eae04b06525d65b839f2c9c5428c436"><td class="mdescLeft">&#160;</td><td class="mdescRight">return a temporal expression storing standard uniform [0,1) the temporal tensor is only valid before next call of gaussian or uniform can be used as part of expression Caution: this means expression such as A = uniform(s1) * uniform(s2) will give invalid result, since second call of gaussian(s2) makes gaussian(s1) invalid A = gaussian(s1)*B+C; is correct; use one gaussian/uniform in each expression <a href="#a4eae04b06525d65b839f2c9c5428c436">More...</a><br /></td></tr>
<tr class="separator:a4eae04b06525d65b839f2c9c5428c436"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02bf4cce9c068da452494452432fcf7f"><td class="memItemLeft" align="right" valign="top">std::mt19937 &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1Random_3_01cpu_00_01DType_01_4.html#a02bf4cce9c068da452494452432fcf7f">GetRndEngine</a> ()</td></tr>
<tr class="separator:a02bf4cce9c068da452494452432fcf7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename DType&gt;<br />
class mshadow::Random&lt; cpu, DType &gt;</h3>
<p>CPU random number generator. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a468829a8a58919ec4aadb1e75a6174ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a468829a8a58919ec4aadb1e75a6174ff">&#9670;&nbsp;</a></span>Random()</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"><a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::<a class="el" href="classmshadow_1_1Random.html">Random</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>seed</em></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>constructor of random engine </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>random number seed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a37b7e8cbe08d7c0f6699039cc0bad8b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37b7e8cbe08d7c0f6699039cc0bad8b2">&#9670;&nbsp;</a></span>~Random()</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"><a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::~<a class="el" href="classmshadow_1_1Random.html">Random</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4ca9b27ca3752795017372a05cfce5c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ca9b27ca3752795017372a05cfce5c3">&#9670;&nbsp;</a></span>gaussian()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<div class="memtemplate">
template&lt;int dim&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmshadow_1_1expr_1_1ReshapeExp.html">expr::ReshapeExp</a>&lt;<a class="el" href="structmshadow_1_1Tensor.html">Tensor</a>&lt;<a class="el" href="structmshadow_1_1cpu.html">cpu</a>, 1, DType&gt;, DType, dim, 1&gt; <a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::gaussian </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; dim &gt;&#160;</td>
<td class="paramname"><em>shape</em></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>return a temporal expression storing standard gaussian random variables the temporal tensor is only valid before next call of gaussian or uniform can be used as part of expression Caution: this means expression such as A = gaussian(s1) * gaussian(s2) will give invalid result, since second call of gaussian(s2) makes gaussian(s1) invalid A = gaussian(s1)*B+C; is correct; use one gaussian/uniform in each expression </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shape</td><td>shape of the tensor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a temporal expression storing standard gaussian random variables </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">dim</td><td>dimension of tensor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a02bf4cce9c068da452494452432fcf7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02bf4cce9c068da452494452432fcf7f">&#9670;&nbsp;</a></span>GetRndEngine()</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">std::mt19937&amp; <a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::GetRndEngine </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">
</div>
</div>
<a id="a41b3d2a322bbd6fc2679275b80c27342"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41b3d2a322bbd6fc2679275b80c27342">&#9670;&nbsp;</a></span>GetSeed()</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">unsigned <a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::GetSeed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>get random seed used in random generator </p>
<dl class="section return"><dt>Returns</dt><dd>seed in unsigned </dd></dl>
</div>
</div>
<a id="aff2ec8923288cea076f5fa94897c0bfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff2ec8923288cea076f5fa94897c0bfe">&#9670;&nbsp;</a></span>Seed()</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">void <a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::Seed </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>seed</em></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>seed random number generator using this seed </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>seed of prng </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0096231388917db869409e0f587b1cf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0096231388917db869409e0f587b1cf3">&#9670;&nbsp;</a></span>set_stream()</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">void <a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::set_stream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmshadow_1_1Stream.html">Stream</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a> &gt; *&#160;</td>
<td class="paramname"><em>stream</em></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>set the stream of computation </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>computation stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4eae04b06525d65b839f2c9c5428c436"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eae04b06525d65b839f2c9c5428c436">&#9670;&nbsp;</a></span>uniform()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<div class="memtemplate">
template&lt;int dim&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmshadow_1_1expr_1_1ReshapeExp.html">expr::ReshapeExp</a>&lt;<a class="el" href="structmshadow_1_1Tensor.html">Tensor</a>&lt;<a class="el" href="structmshadow_1_1cpu.html">cpu</a>, 1, DType&gt;, DType, dim, 1&gt; <a class="el" href="classmshadow_1_1Random.html">mshadow::Random</a>&lt; <a class="el" href="structmshadow_1_1cpu.html">cpu</a>, DType &gt;::uniform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; dim &gt;&#160;</td>
<td class="paramname"><em>shape</em></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>return a temporal expression storing standard uniform [0,1) the temporal tensor is only valid before next call of gaussian or uniform can be used as part of expression Caution: this means expression such as A = uniform(s1) * uniform(s2) will give invalid result, since second call of gaussian(s2) makes gaussian(s1) invalid A = gaussian(s1)*B+C; is correct; use one gaussian/uniform in each expression </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shape</td><td>shape of the tensor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a temporal expression storing standard uniform [0,1) </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">dim</td><td>dimension of tensor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/mshadow/mshadow/<a class="el" href="random_8h_source.html">random.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:43 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>