Files
mlpack/doc/html/mean__split_8hpp_source.html
T

123 lines
19 KiB
HTML

<!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: src/mlpack/core/tree/binary_space_tree/mean_split.hpp Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44a936ef30fc126706c6284a2fc0c990.html">mlpack</a></li><li class="navelem"><a class="el" href="dir_f7ac9cdfd28b2e882eb44d163e3b98b4.html">core</a></li><li class="navelem"><a class="el" href="dir_d361cbf9654077cd65f7968e3f8eccf6.html">tree</a></li><li class="navelem"><a class="el" href="dir_f2c902aa2e0a74bdfe4e54224fb2267f.html">binary_space_tree</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">mean_split.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="mean__split_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef MLPACK_CORE_TREE_BINARY_SPACE_TREE_MEAN_SPLIT_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define MLPACK_CORE_TREE_BINARY_SPACE_TREE_MEAN_SPLIT_HPP</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="perform__split_8hpp.html">mlpack/core/tree/perform_split.hpp</a>&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span>tree {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> BoundType, <span class="keyword">typename</span> MatType = arma::mat&gt;</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1MeanSplit.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1tree_1_1MeanSplit.html">MeanSplit</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html"> 33</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html">SplitInfo</a></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#a3c5a79c2134835b1fe3be0baac0b2edc"> 36</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#a3c5a79c2134835b1fe3be0baac0b2edc">splitDimension</a>;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#aeee251f5d8e7a14f9024a2714cf1cc0f"> 38</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#aeee251f5d8e7a14f9024a2714cf1cc0f">splitVal</a>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1MeanSplit.html#acf8b29f41661b5f29ee52404d519bbc0">SplitNode</a>(<span class="keyword">const</span> BoundType&amp; bound,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; MatType&amp; data,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> begin,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> count,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html">SplitInfo</a>&amp; splitInfo);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1MeanSplit.html#acdc76446639adca9a0ba8c437d1a8ccb"> 73</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1tree_1_1MeanSplit.html#acdc76446639adca9a0ba8c437d1a8ccb">PerformSplit</a>(MatType&amp; data,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> begin,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> count,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">const</span> <a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html">SplitInfo</a>&amp; splitInfo)</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">return</span> split::PerformSplit&lt;MatType, MeanSplit&gt;(data, begin, count,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; splitInfo);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1MeanSplit.html#adfe66b93425da8c86dd53854319c0a56"> 98</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1tree_1_1MeanSplit.html#adfe66b93425da8c86dd53854319c0a56">PerformSplit</a>(MatType&amp; data,</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> begin,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> count,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> <a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html">SplitInfo</a>&amp; splitInfo,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; std::vector&lt;size_t&gt;&amp; oldFromNew)</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">return</span> split::PerformSplit&lt;MatType, MeanSplit&gt;(data, begin, count,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; splitInfo, oldFromNew);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> VecType&gt;</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1MeanSplit.html#a6fd99fb994866dd7313335155271b511"> 115</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1MeanSplit.html#a6fd99fb994866dd7313335155271b511">AssignToLeftNode</a>(<span class="keyword">const</span> VecType&amp; point,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keyword">const</span> <a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html">SplitInfo</a>&amp; splitInfo)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">return</span> point[splitInfo.<a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#a3c5a79c2134835b1fe3be0baac0b2edc">splitDimension</a>] &lt; splitInfo.<a class="code" href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#aeee251f5d8e7a14f9024a2714cf1cc0f">splitVal</a>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;};</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;} <span class="comment">// namespace tree</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment">// Include implementation.</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="preprocessor">#include &quot;mean_split_impl.hpp&quot;</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespacemlpack_html"><div class="ttname"><a href="namespacemlpack.html">mlpack</a></div><div class="ttdoc">Linear algebra utility functions, generally performed on matrices or vectors. </div><div class="ttdef"><b>Definition:</b> <a href="binarize_8hpp_source.html#l00018">binarize.hpp:18</a></div></div>
<div class="ttc" id="prereqs_8hpp_html"><div class="ttname"><a href="prereqs_8hpp.html">prereqs.hpp</a></div><div class="ttdoc">The core includes that mlpack expects; standard C++ includes and Armadillo. </div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1MeanSplit_html_acdc76446639adca9a0ba8c437d1a8ccb"><div class="ttname"><a href="classmlpack_1_1tree_1_1MeanSplit.html#acdc76446639adca9a0ba8c437d1a8ccb">mlpack::tree::MeanSplit::PerformSplit</a></div><div class="ttdeci">static size_t PerformSplit(MatType &amp;data, const size_t begin, const size_t count, const SplitInfo &amp;splitInfo)</div><div class="ttdoc">Perform the split process according to the information about the split. </div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00073">mean_split.hpp:73</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1MeanSplit_html_adfe66b93425da8c86dd53854319c0a56"><div class="ttname"><a href="classmlpack_1_1tree_1_1MeanSplit.html#adfe66b93425da8c86dd53854319c0a56">mlpack::tree::MeanSplit::PerformSplit</a></div><div class="ttdeci">static size_t PerformSplit(MatType &amp;data, const size_t begin, const size_t count, const SplitInfo &amp;splitInfo, std::vector&lt; size_t &gt; &amp;oldFromNew)</div><div class="ttdoc">Perform the split process according to the information about the split and return the list of changed...</div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00098">mean_split.hpp:98</a></div></div>
<div class="ttc" id="perform__split_8hpp_html"><div class="ttname"><a href="perform__split_8hpp.html">perform_split.hpp</a></div></div>
<div class="ttc" id="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo_html"><div class="ttname"><a href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html">mlpack::tree::MeanSplit::SplitInfo</a></div><div class="ttdoc">An information about the partition. </div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00033">mean_split.hpp:33</a></div></div>
<div class="ttc" id="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo_html_a3c5a79c2134835b1fe3be0baac0b2edc"><div class="ttname"><a href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#a3c5a79c2134835b1fe3be0baac0b2edc">mlpack::tree::MeanSplit::SplitInfo::splitDimension</a></div><div class="ttdeci">size_t splitDimension</div><div class="ttdoc">The dimension to split the node on. </div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00036">mean_split.hpp:36</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1MeanSplit_html_a6fd99fb994866dd7313335155271b511"><div class="ttname"><a href="classmlpack_1_1tree_1_1MeanSplit.html#a6fd99fb994866dd7313335155271b511">mlpack::tree::MeanSplit::AssignToLeftNode</a></div><div class="ttdeci">static bool AssignToLeftNode(const VecType &amp;point, const SplitInfo &amp;splitInfo)</div><div class="ttdoc">Indicates that a point should be assigned to the left subtree. </div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00115">mean_split.hpp:115</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1MeanSplit_html"><div class="ttname"><a href="classmlpack_1_1tree_1_1MeanSplit.html">mlpack::tree::MeanSplit</a></div><div class="ttdoc">A binary space partitioning tree node is split into its left and right child. </div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00029">mean_split.hpp:29</a></div></div>
<div class="ttc" id="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo_html_aeee251f5d8e7a14f9024a2714cf1cc0f"><div class="ttname"><a href="structmlpack_1_1tree_1_1MeanSplit_1_1SplitInfo.html#aeee251f5d8e7a14f9024a2714cf1cc0f">mlpack::tree::MeanSplit::SplitInfo::splitVal</a></div><div class="ttdeci">double splitVal</div><div class="ttdoc">The split in dimension splitDimension is based on this value. </div><div class="ttdef"><b>Definition:</b> <a href="mean__split_8hpp_source.html#l00038">mean_split.hpp:38</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1MeanSplit_html_acf8b29f41661b5f29ee52404d519bbc0"><div class="ttname"><a href="classmlpack_1_1tree_1_1MeanSplit.html#acf8b29f41661b5f29ee52404d519bbc0">mlpack::tree::MeanSplit::SplitNode</a></div><div class="ttdeci">static bool SplitNode(const BoundType &amp;bound, MatType &amp;data, const size_t begin, const size_t count, SplitInfo &amp;splitInfo)</div><div class="ttdoc">Find the partition of the node. </div></div>
</div><!-- fragment --></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>