apaam/mlpack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
1c29be5ccb2e971fbe376129f6782d421a47da0c
mlpack/doc/html/classmlpack_1_1ann_1_1RandomInitialization.html
T

410 lines
19 KiB
HTML
Raw Blame History

<!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.11"/>
<title>mlpack: mlpack::ann::RandomInitialization 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="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">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra-stylesheet.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">mlpack
&#160;<span id="projectnumber">master</span>
</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 id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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 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>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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="namespacemlpack.html">mlpack</a></li><li class="navelem"><a class="el" href="namespacemlpack_1_1ann.html">ann</a></li><li class="navelem"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html">RandomInitialization</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classmlpack_1_1ann_1_1RandomInitialization-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mlpack::ann::RandomInitialization Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is used to initialize randomly the weight matrix.
<a href="classmlpack_1_1ann_1_1RandomInitialization.html#details">More...</a></p>
<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:a759e46080f26bb7ca56a43dbac892255"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#a759e46080f26bb7ca56a43dbac892255">RandomInitialization</a> (const double <a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a>=-1, const double <a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a>=1)</td></tr>
<tr class="memdesc:a759e46080f26bb7ca56a43dbac892255"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the random initialization rule with the given lower bound and upper bound. <a href="#a759e46080f26bb7ca56a43dbac892255">More...</a><br /></td></tr>
<tr class="separator:a759e46080f26bb7ca56a43dbac892255"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a710c60d81b3b8d069e462a7c6d4fca98"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#a710c60d81b3b8d069e462a7c6d4fca98">RandomInitialization</a> (const double bound)</td></tr>
<tr class="memdesc:a710c60d81b3b8d069e462a7c6d4fca98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the random initialization rule with the given bound. <a href="#a710c60d81b3b8d069e462a7c6d4fca98">More...</a><br /></td></tr>
<tr class="separator:a710c60d81b3b8d069e462a7c6d4fca98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80d8b73d04b33ce114cfb4663831747c"><td class="memTemplParams" colspan="2">template&lt;typename eT &gt; </td></tr>
<tr class="memitem:a80d8b73d04b33ce114cfb4663831747c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#a80d8b73d04b33ce114cfb4663831747c">Initialize</a> (arma::Mat&lt; eT &gt; &amp;W, const size_t rows, const size_t cols)</td></tr>
<tr class="memdesc:a80d8b73d04b33ce114cfb4663831747c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize randomly the elements of the specified weight matrix. <a href="#a80d8b73d04b33ce114cfb4663831747c">More...</a><br /></td></tr>
<tr class="separator:a80d8b73d04b33ce114cfb4663831747c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3285c0c7ae0fdf57453e86f610fee91f"><td class="memTemplParams" colspan="2">template&lt;typename eT &gt; </td></tr>
<tr class="memitem:a3285c0c7ae0fdf57453e86f610fee91f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#a3285c0c7ae0fdf57453e86f610fee91f">Initialize</a> (arma::Cube&lt; eT &gt; &amp;W, const size_t rows, const size_t cols, const size_t slices)</td></tr>
<tr class="memdesc:a3285c0c7ae0fdf57453e86f610fee91f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize randomly the elements of the specified weight 3rd order tensor. <a href="#a3285c0c7ae0fdf57453e86f610fee91f">More...</a><br /></td></tr>
<tr class="separator:a3285c0c7ae0fdf57453e86f610fee91f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:abae29d086c221a9575565960cd77bc43"><td class="memItemLeft" align="right" valign="top">const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#abae29d086c221a9575565960cd77bc43">lowerBound</a></td></tr>
<tr class="memdesc:abae29d086c221a9575565960cd77bc43"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number used as lower bound. <a href="#abae29d086c221a9575565960cd77bc43">More...</a><br /></td></tr>
<tr class="separator:abae29d086c221a9575565960cd77bc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab511dd4546b50164dc27033a4ec01e0c"><td class="memItemLeft" align="right" valign="top">const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1ann_1_1RandomInitialization.html#ab511dd4546b50164dc27033a4ec01e0c">upperBound</a></td></tr>
<tr class="memdesc:ab511dd4546b50164dc27033a4ec01e0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number used as upper bound. <a href="#ab511dd4546b50164dc27033a4ec01e0c">More...</a><br /></td></tr>
<tr class="separator:ab511dd4546b50164dc27033a4ec01e0c"><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>This class is used to initialize randomly the weight matrix. </p>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00024">24</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a759e46080f26bb7ca56a43dbac892255"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mlpack::ann::RandomInitialization::RandomInitialization </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>lowerBound</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>upperBound</em> = <code>1</code>&#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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the random initialization rule with the given lower bound and upper bound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lowerBound</td><td>The number used as lower bound. </td></tr>
<tr><td class="paramname">upperBound</td><td>The number used as upper bound. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00034">34</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a710c60d81b3b8d069e462a7c6d4fca98"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mlpack::ann::RandomInitialization::RandomInitialization </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>bound</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>Initialize the random initialization rule with the given bound. </p>
<p>Using the negative of the bound as lower bound and the positive bound as upper bound.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bound</td><td>The number used as lower bound </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00045">45</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a80d8b73d04b33ce114cfb4663831747c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename eT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mlpack::ann::RandomInitialization::Initialize </td>
<td>(</td>
<td class="paramtype">arma::Mat&lt; eT &gt; &amp;&#160;</td>
<td class="paramname"><em>W</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>rows</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>cols</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize randomly the elements of the specified weight matrix. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">W</td><td>Weight matrix to initialize. </td></tr>
<tr><td class="paramname">rows</td><td>Number of rows. </td></tr>
<tr><td class="paramname">cols</td><td>Number of columns. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00056">56</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
<p>References <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00083">lowerBound</a>, and <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00086">upperBound</a>.</p>
<p>Referenced by <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00070">Initialize()</a>, <a class="el" href="nguyen__widrow__init_8hpp_source.html#l00075">mlpack::ann::NguyenWidrowInitialization::Initialize()</a>, <a class="el" href="kathirvalavakumar__subavathi__init_8hpp_source.html#l00081">mlpack::ann::KathirvalavakumarSubavathiInitialization::Initialize()</a>, and <a class="el" href="oivs__init_8hpp_source.html#l00086">mlpack::ann::OivsInitialization&lt; ActivationFunction &gt;::Initialize()</a>.</p>
</div>
</div>
<a class="anchor" id="a3285c0c7ae0fdf57453e86f610fee91f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename eT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mlpack::ann::RandomInitialization::Initialize </td>
<td>(</td>
<td class="paramtype">arma::Cube&lt; eT &gt; &amp;&#160;</td>
<td class="paramname"><em>W</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>rows</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>slices</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize randomly the elements of the specified weight 3rd order tensor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">W</td><td>Weight matrix to initialize. </td></tr>
<tr><td class="paramname">rows</td><td>Number of rows. </td></tr>
<tr><td class="paramname">cols</td><td>Number of columns. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00070">70</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
<p>References <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00056">Initialize()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abae29d086c221a9575565960cd77bc43"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const double mlpack::ann::RandomInitialization::lowerBound</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number used as lower bound. </p>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00083">83</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
<p>Referenced by <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00056">Initialize()</a>.</p>
</div>
</div>
<a class="anchor" id="ab511dd4546b50164dc27033a4ec01e0c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const double mlpack::ann::RandomInitialization::upperBound</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number used as upper bound. </p>
<p>Definition at line <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00086">86</a> of file <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a>.</p>
<p>Referenced by <a class="el" href="ann_2init__rules_2random__init_8hpp_source.html#l00056">Initialize()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mlpack/methods/ann/init_rules/<a class="el" href="ann_2init__rules_2random__init_8hpp_source.html">random_init.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
<script type="text/javascript">
var x = document.getElementsByClassName("formulaDsp");
var i;
for (i = 0; i < x.length; i++)
{
x[i].width /= 4;
}
</script>
</html>
Reference in New Issue View Git Blame Copy Permalink