125 lines
21 KiB
HTML
125 lines
21 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/rectangle_tree/single_tree_traverser.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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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_7919cd971787b4fc956a50aa3613ed0a.html">rectangle_tree</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">single_tree_traverser.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="rectangle__tree_2single__tree__traverser_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> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef MLPACK_CORE_TREE_RECTANGLE_TREE_SINGLE_TREE_TRAVERSER_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define MLPACK_CORE_TREE_RECTANGLE_TREE_SINGLE_TREE_TRAVERSER_HPP</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="rectangle__tree_2rectangle__tree_8hpp.html">rectangle_tree.hpp</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>tree {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">template</span><<span class="keyword">typename</span> MetricType,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">typename</span> StatisticType,</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">typename</span> MatType,</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">typename</span> SplitType,</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">typename</span> DescentType,</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">template</span><<span class="keyword">typename</span>> <span class="keyword">class </span>AuxiliaryInformationType></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span><<span class="keyword">typename</span> RuleType></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>RectangleTree<MetricType, StatisticType, MatType, SplitType,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  DescentType, AuxiliaryInformationType>::SingleTreeTraverser</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  SingleTreeTraverser(RuleType& rule);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> Traverse(<span class="keyword">const</span> <span class="keywordtype">size_t</span> queryIndex, <span class="keyword">const</span> <a class="code" href="classmlpack_1_1tree_1_1RectangleTree.html#a0a65ef887779d8d086f56de15ff4f657">RectangleTree</a>& referenceNode);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a2aa40078d54b7171768a56beee55c56e"> 50</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a2aa40078d54b7171768a56beee55c56e">NumPrunes</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> numPrunes; }</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a1e8610e615f24c9c3d5ba30049d73ec2"> 52</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a1e8610e615f24c9c3d5ba30049d73ec2">NumPrunes</a>() { <span class="keywordflow">return</span> numPrunes; }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// We use this class and this function to make the sorting and scoring easy</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// and efficient:</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html"> 58</a></span>  <span class="keyword">struct </span><a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html">NodeAndScore</a></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  {</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#ac5c95e3f3fa1e57bd291a513590ca02b"> 60</a></span>  <a class="code" href="classmlpack_1_1tree_1_1RectangleTree.html">RectangleTree</a>* <a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#ac5c95e3f3fa1e57bd291a513590ca02b">node</a>;</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#a222b51e691eddeede0a778929c63de7a"> 61</a></span>  <span class="keywordtype">double</span> <a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#a222b51e691eddeede0a778929c63de7a">score</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  };</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#ab055847fd6c9248198bce4d01a88c907"> 64</a></span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#ab055847fd6c9248198bce4d01a88c907">NodeComparator</a>(<span class="keyword">const</span> <a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html">NodeAndScore</a>& obj1, <span class="keyword">const</span> <a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html">NodeAndScore</a>& obj2)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> obj1.<a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#a222b51e691eddeede0a778929c63de7a">score</a> < obj2.<a class="code" href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#a222b51e691eddeede0a778929c63de7a">score</a>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a9c66d3216923a24966bbeed9aa1f582e"> 70</a></span>  RuleType& <a class="code" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a9c66d3216923a24966bbeed9aa1f582e">rule</a>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a2a4cf8b17057a1d2d805176c5e97b408"> 73</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a2a4cf8b17057a1d2d805176c5e97b408">numPrunes</a>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> };</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> } <span class="comment">// namespace tree</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#include "single_tree_traverser_impl.hpp"</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_html_a2a4cf8b17057a1d2d805176c5e97b408"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a2a4cf8b17057a1d2d805176c5e97b408">mlpack::tree::RectangleTree::SingleTreeTraverser::numPrunes</a></div><div class="ttdeci">size_t numPrunes</div><div class="ttdoc">The number of nodes which have been prenud during traversal. </div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00073">single_tree_traverser.hpp:73</a></div></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="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore_html"><div class="ttname"><a href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html">mlpack::tree::RectangleTree::SingleTreeTraverser::NodeAndScore</a></div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00058">single_tree_traverser.hpp:58</a></div></div>
|
|
<div class="ttc" id="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore_html_ac5c95e3f3fa1e57bd291a513590ca02b"><div class="ttname"><a href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#ac5c95e3f3fa1e57bd291a513590ca02b">mlpack::tree::RectangleTree::SingleTreeTraverser::NodeAndScore::node</a></div><div class="ttdeci">RectangleTree * node</div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00060">single_tree_traverser.hpp:60</a></div></div>
|
|
<div class="ttc" id="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore_html_a222b51e691eddeede0a778929c63de7a"><div class="ttname"><a href="structmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_1_1NodeAndScore.html#a222b51e691eddeede0a778929c63de7a">mlpack::tree::RectangleTree::SingleTreeTraverser::NodeAndScore::score</a></div><div class="ttdeci">double score</div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00061">single_tree_traverser.hpp:61</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_html_a9c66d3216923a24966bbeed9aa1f582e"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a9c66d3216923a24966bbeed9aa1f582e">mlpack::tree::RectangleTree::SingleTreeTraverser::rule</a></div><div class="ttdeci">RuleType & rule</div><div class="ttdoc">Reference to the rules with which the tree will be traversed. </div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00070">single_tree_traverser.hpp:70</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_html"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree.html">mlpack::tree::RectangleTree</a></div><div class="ttdoc">A rectangle type tree tree, such as an R-tree or X-tree. </div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2rectangle__tree_8hpp_source.html#l00053">rectangle_tree.hpp:53</a></div></div>
|
|
<div class="ttc" id="rectangle__tree_2rectangle__tree_8hpp_html"><div class="ttname"><a href="rectangle__tree_2rectangle__tree_8hpp.html">rectangle_tree.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_html_a0a65ef887779d8d086f56de15ff4f657"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree.html#a0a65ef887779d8d086f56de15ff4f657">mlpack::tree::RectangleTree::RectangleTree</a></div><div class="ttdeci">RectangleTree()</div><div class="ttdoc">A default constructor. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_html_a1e8610e615f24c9c3d5ba30049d73ec2"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a1e8610e615f24c9c3d5ba30049d73ec2">mlpack::tree::RectangleTree::SingleTreeTraverser::NumPrunes</a></div><div class="ttdeci">size_t & NumPrunes()</div><div class="ttdoc">Modify the number of prunes. </div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00052">single_tree_traverser.hpp:52</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_html_ab055847fd6c9248198bce4d01a88c907"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#ab055847fd6c9248198bce4d01a88c907">mlpack::tree::RectangleTree::SingleTreeTraverser::NodeComparator</a></div><div class="ttdeci">static bool NodeComparator(const NodeAndScore &obj1, const NodeAndScore &obj2)</div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00064">single_tree_traverser.hpp:64</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser_html_a2aa40078d54b7171768a56beee55c56e"><div class="ttname"><a href="classmlpack_1_1tree_1_1RectangleTree_1_1SingleTreeTraverser.html#a2aa40078d54b7171768a56beee55c56e">mlpack::tree::RectangleTree::SingleTreeTraverser::NumPrunes</a></div><div class="ttdeci">size_t NumPrunes() const </div><div class="ttdoc">Get the number of prunes. </div><div class="ttdef"><b>Definition:</b> <a href="rectangle__tree_2single__tree__traverser_8hpp_source.html#l00050">single_tree_traverser.hpp:50</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <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>
|