Files
mlpack/doc/html/cover__tree_2traits_8hpp_source.html
T

123 lines
17 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/cover_tree/traits.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_8909127a93079ea6b332007d78eda270.html">cover_tree</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">traits.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="cover__tree_2traits_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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef MLPACK_CORE_TREE_COVER_TREE_TRAITS_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define MLPACK_CORE_TREE_COVER_TREE_TRAITS_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="tree__traits_8hpp.html">mlpack/core/tree/tree_traits.hpp</a>&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>tree {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> MetricType,</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">typename</span> StatisticType,</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">typename</span> MatType,</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">typename</span> RootPointPolicy&gt;</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html"> 31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html">TreeTraits</a>&lt;<a class="code" href="classmlpack_1_1tree_1_1CoverTree.html">CoverTree</a>&lt;MetricType, StatisticType, MatType, RootPointPolicy&gt;&gt;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#adb6b72a4a9080e9a57a94fd21f19fd98"> 38</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#af1498fa2514423f81fc30a3c67c694fb">HasOverlappingChildren</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#a2d68e6640d774f9bcf9d8ec8e98d467f"> 44</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#ab386d6cc4c474b5201cb94005100c6f2">HasDuplicatedPoints</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#a14b78196569c0dfde0b9e22ff58fb7f7"> 50</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#a4751f17406c9202f3c0228e6307dd22f">FirstPointIsCentroid</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#a459e11ad667b321f60a78649b94d83a2"> 55</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#a4f47cb87cdee54e84617d9ac49d6c6cd">HasSelfChildren</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#a62166cdde2b4ec5f8b37c13aadf16235"> 60</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#ae6207c6ccffcc6ff51e60f5edbe40d05">RearrangesDataset</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#af5c9de674624b85252c356a422a34983"> 65</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#af012af0a98e4dd36c2754cf1dbb202f0">BinaryTree</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classmlpack_1_1tree_1_1TreeTraits_3_01CoverTree_3_01MetricType_00_01StatisticType_00_01MatType_00_01RootPointPolicy_01_4_01_4.html#aa1fbca79fec713a36bf51408f451facd"> 70</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#a13c453e1f11e7ac2724dcaf2a9c92243">UniqueNumDescendants</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;};</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace tree</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</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="classmlpack_1_1tree_1_1TreeTraits_html_ae6207c6ccffcc6ff51e60f5edbe40d05"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#ae6207c6ccffcc6ff51e60f5edbe40d05">mlpack::tree::TreeTraits::RearrangesDataset</a></div><div class="ttdeci">static const bool RearrangesDataset</div><div class="ttdoc">This is true if the tree rearranges points in the dataset when it is built. </div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00105">tree_traits.hpp:105</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html_af1498fa2514423f81fc30a3c67c694fb"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#af1498fa2514423f81fc30a3c67c694fb">mlpack::tree::TreeTraits::HasOverlappingChildren</a></div><div class="ttdeci">static const bool HasOverlappingChildren</div><div class="ttdoc">This is true if the subspaces represented by the children of a node can overlap. </div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00084">tree_traits.hpp:84</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html_a4751f17406c9202f3c0228e6307dd22f"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#a4751f17406c9202f3c0228e6307dd22f">mlpack::tree::TreeTraits::FirstPointIsCentroid</a></div><div class="ttdeci">static const bool FirstPointIsCentroid</div><div class="ttdoc">This is true if the first point of each node is the centroid of its bound. </div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00094">tree_traits.hpp:94</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html_a13c453e1f11e7ac2724dcaf2a9c92243"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#a13c453e1f11e7ac2724dcaf2a9c92243">mlpack::tree::TreeTraits::UniqueNumDescendants</a></div><div class="ttdeci">static const bool UniqueNumDescendants</div><div class="ttdoc">This is true if the NumDescendants() method doesn&amp;#39;t include duplicated points. </div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00116">tree_traits.hpp:116</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html_ab386d6cc4c474b5201cb94005100c6f2"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#ab386d6cc4c474b5201cb94005100c6f2">mlpack::tree::TreeTraits::HasDuplicatedPoints</a></div><div class="ttdeci">static const bool HasDuplicatedPoints</div><div class="ttdoc">This is true if a point can be included in more than one node. </div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00089">tree_traits.hpp:89</a></div></div>
<div class="ttc" id="tree__traits_8hpp_html"><div class="ttname"><a href="tree__traits_8hpp.html">tree_traits.hpp</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a></div><div class="ttdoc">The TreeTraits class provides compile-time information on the characteristics of a given tree type...</div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00077">tree_traits.hpp:77</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html_af012af0a98e4dd36c2754cf1dbb202f0"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#af012af0a98e4dd36c2754cf1dbb202f0">mlpack::tree::TreeTraits::BinaryTree</a></div><div class="ttdeci">static const bool BinaryTree</div><div class="ttdoc">This is true if the tree always has only two children. </div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00110">tree_traits.hpp:110</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1CoverTree_html"><div class="ttname"><a href="classmlpack_1_1tree_1_1CoverTree.html">mlpack::tree::CoverTree</a></div><div class="ttdoc">A cover tree is a tree specifically designed to speed up nearest-neighbor computation in high-dimensi...</div><div class="ttdef"><b>Definition:</b> <a href="cover__tree_2cover__tree_8hpp_source.html#l00099">cover_tree.hpp:99</a></div></div>
<div class="ttc" id="classmlpack_1_1tree_1_1TreeTraits_html_a4f47cb87cdee54e84617d9ac49d6c6cd"><div class="ttname"><a href="classmlpack_1_1tree_1_1TreeTraits.html#a4f47cb87cdee54e84617d9ac49d6c6cd">mlpack::tree::TreeTraits::HasSelfChildren</a></div><div class="ttdeci">static const bool HasSelfChildren</div><div class="ttdoc">This is true if the points contained in the first child of a node (Child(0)) are also contained in th...</div><div class="ttdef"><b>Definition:</b> <a href="tree__traits_8hpp_source.html#l00100">tree_traits.hpp:100</a></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>