blob: ec5454dafb6c817f3b548f4e5c4e30a43c17ee0e [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.11" name="generator"/>
<title>mxnet: mxnet::cpp::Initializer Class 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/searchdata.js" type="text/javascript"></script>
<script src="search/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 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.11 -->
<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()">
</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_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html">Initializer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classmxnet_1_1cpp_1_1Initializer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::Initializer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="initializer_8h_source.html">initializer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mxnet::cpp::Initializer:</div>
<div class="dyncontent">
<div class="center"><img alt="Inheritance graph" border="0" src="classmxnet_1_1cpp_1_1Initializer__inherit__graph.png" usemap="#mxnet_1_1cpp_1_1Initializer_inherit__map"/></div>
<map id="mxnet_1_1cpp_1_1Initializer_inherit__map" name="mxnet_1_1cpp_1_1Initializer_inherit__map">
<area alt="" coords="5,292,155,384" href="classmxnet_1_1cpp_1_1Bilinear.html" id="node2" shape="rect" title="{mxnet::cpp::Bilinear\n||+ Bilinear()\l+ operator()()\l}"/>
<area alt="" coords="179,292,339,384" href="classmxnet_1_1cpp_1_1Constant.html" id="node3" shape="rect" title="{mxnet::cpp::Constant\n|# value\l|+ Constant()\l+ operator()()\l}"/>
<area alt="" coords="363,285,512,391" href="classmxnet_1_1cpp_1_1Normal.html" id="node6" shape="rect" title="{mxnet::cpp::Normal\n|# mu\l# sigma\l|+ Normal()\l+ operator()()\l}"/>
<area alt="" coords="537,277,690,399" href="classmxnet_1_1cpp_1_1Uniform.html" id="node7" shape="rect" title="{mxnet::cpp::Uniform\n|# begin\l# end\l|+ Uniform()\l+ Uniform()\l+ operator()()\l}"/>
<area alt="" coords="715,277,856,399" href="classmxnet_1_1cpp_1_1Xavier.html" id="node8" shape="rect" title="{mxnet::cpp::Xavier\n|+ rand_type\l+ factor_type\l+ magnitude\l|+ Xavier()\l+ operator()()\l}"/>
<area alt="" coords="117,447,245,524" href="classmxnet_1_1cpp_1_1One.html" id="node4" shape="rect" title="{mxnet::cpp::One\n||+ One()\l}"/>
<area alt="" coords="269,447,403,524" href="classmxnet_1_1cpp_1_1Zero.html" id="node5" shape="rect" title="{mxnet::cpp::Zero\n||+ Zero()\l}"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::Initializer:</div>
<div class="dyncontent">
<div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1Initializer__coll__graph.png" usemap="#mxnet_1_1cpp_1_1Initializer_coll__map"/></div>
<map id="mxnet_1_1cpp_1_1Initializer_coll__map" name="mxnet_1_1cpp_1_1Initializer_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:ae5433275b7947c594e0843bcd51c440d"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#ae5433275b7947c594e0843bcd51c440d">operator()</a> (const std::string &amp;name, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:ae5433275b7947c594e0843bcd51c440d"><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:a98956a16ba4f737abe2a2220c7099d1f"><td align="right" class="memItemLeft" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#a98956a16ba4f737abe2a2220c7099d1f">StringStartWith</a> (const std::string &amp;name, const std::string &amp;check_str)</td></tr>
<tr class="separator:a98956a16ba4f737abe2a2220c7099d1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a414f77fe78a848522be9787a41ad4e46"><td align="right" class="memItemLeft" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#a414f77fe78a848522be9787a41ad4e46">StringEndWith</a> (const std::string &amp;name, const std::string &amp;check_str)</td></tr>
<tr class="separator:a414f77fe78a848522be9787a41ad4e46"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a258396185c26a56d18ae558324007a33"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#a258396185c26a56d18ae558324007a33">InitBilinear</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:a258396185c26a56d18ae558324007a33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff984d00cd195a88f9d818b915d2dd8f"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#aff984d00cd195a88f9d818b915d2dd8f">InitZero</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:aff984d00cd195a88f9d818b915d2dd8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3838d4a6bd93b61439eab72002a396c"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#af3838d4a6bd93b61439eab72002a396c">InitOne</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:af3838d4a6bd93b61439eab72002a396c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52695e1fddc504999fecaee60d874e4e"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#a52695e1fddc504999fecaee60d874e4e">InitBias</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:a52695e1fddc504999fecaee60d874e4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ebebb65975a87d2d323ce2e55f14485"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#a5ebebb65975a87d2d323ce2e55f14485">InitGamma</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:a5ebebb65975a87d2d323ce2e55f14485"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3be5c057362a65fa7dcd2b828eeaa5d"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#ac3be5c057362a65fa7dcd2b828eeaa5d">InitBeta</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:ac3be5c057362a65fa7dcd2b828eeaa5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae94ab07a6d5c41917ccde3edfda72855"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#ae94ab07a6d5c41917ccde3edfda72855">InitWeight</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:ae94ab07a6d5c41917ccde3edfda72855"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ad1f020e184cef117e9fc334f3a7152"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Initializer.html#a5ad1f020e184cef117e9fc334f3a7152">InitDefault</a> (<a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> *arr)</td></tr>
<tr class="separator:a5ad1f020e184cef117e9fc334f3a7152"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac3be5c057362a65fa7dcd2b828eeaa5d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitBeta </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a52695e1fddc504999fecaee60d874e4e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitBias </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a258396185c26a56d18ae558324007a33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitBilinear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5ad1f020e184cef117e9fc334f3a7152"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitDefault </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5ebebb65975a87d2d323ce2e55f14485"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitGamma </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af3838d4a6bd93b61439eab72002a396c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitOne </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae94ab07a6d5c41917ccde3edfda72855"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitWeight </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aff984d00cd195a88f9d818b915d2dd8f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::InitZero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae5433275b7947c594e0843bcd51c440d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::cpp::Initializer::operator() </td>
<td>(</td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a></td>
<td class="paramname"><em>arr</em> </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented in <a class="el" href="classmxnet_1_1cpp_1_1Xavier.html#a8c3ec1473c0a784e3a23ba9274911b07">mxnet::cpp::Xavier</a>, <a class="el" href="classmxnet_1_1cpp_1_1Bilinear.html#aa770ae2d60c777709480fbcf7e7fc6df">mxnet::cpp::Bilinear</a>, <a class="el" href="classmxnet_1_1cpp_1_1Normal.html#ab6420ab1d1fe417f610b7f6ed979940b">mxnet::cpp::Normal</a>, <a class="el" href="classmxnet_1_1cpp_1_1Uniform.html#ab944a4db582dce55bb12c2aa524cc52e">mxnet::cpp::Uniform</a>, and <a class="el" href="classmxnet_1_1cpp_1_1Constant.html#a4d080d6801e0b7baa2689bbb6cd4d596">mxnet::cpp::Constant</a>.</p>
</div>
</div>
<a class="anchor" id="a414f77fe78a848522be9787a41ad4e46"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mxnet::cpp::Initializer::StringEndWith </td>
<td>(</td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>check_str</em> </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a98956a16ba4f737abe2a2220c7099d1f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mxnet::cpp::Initializer::StringStartWith </td>
<td>(</td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>check_str</em> </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">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>cpp-package/include/mxnet-cpp/<a class="el" href="initializer_8h_source.html">initializer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 19 2019 13:08:40 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.11
</small></address>
</body>
</html>