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

344 lines
21 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::tree::TreeTraits&lt; TreeType &gt; Class Template 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_1tree.html">tree</a></li><li class="navelem"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">TreeTraits</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classmlpack_1_1tree_1_1TreeTraits-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mlpack::tree::TreeTraits&lt; TreeType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html" title="The TreeTraits class provides compile-time information on the characteristics of a given tree type...">TreeTraits</a> class provides compile-time information on the characteristics of a given tree type.
<a href="classmlpack_1_1tree_1_1TreeTraits.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af012af0a98e4dd36c2754cf1dbb202f0"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#af012af0a98e4dd36c2754cf1dbb202f0">BinaryTree</a> = false</td></tr>
<tr class="memdesc:af012af0a98e4dd36c2754cf1dbb202f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if the tree always has only two children. <a href="#af012af0a98e4dd36c2754cf1dbb202f0">More...</a><br /></td></tr>
<tr class="separator:af012af0a98e4dd36c2754cf1dbb202f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4751f17406c9202f3c0228e6307dd22f"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#a4751f17406c9202f3c0228e6307dd22f">FirstPointIsCentroid</a> = false</td></tr>
<tr class="memdesc:a4751f17406c9202f3c0228e6307dd22f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if the first point of each node is the centroid of its bound. <a href="#a4751f17406c9202f3c0228e6307dd22f">More...</a><br /></td></tr>
<tr class="separator:a4751f17406c9202f3c0228e6307dd22f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab386d6cc4c474b5201cb94005100c6f2"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#ab386d6cc4c474b5201cb94005100c6f2">HasDuplicatedPoints</a> = false</td></tr>
<tr class="memdesc:ab386d6cc4c474b5201cb94005100c6f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if a point can be included in more than one node. <a href="#ab386d6cc4c474b5201cb94005100c6f2">More...</a><br /></td></tr>
<tr class="separator:ab386d6cc4c474b5201cb94005100c6f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1498fa2514423f81fc30a3c67c694fb"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#af1498fa2514423f81fc30a3c67c694fb">HasOverlappingChildren</a> = true</td></tr>
<tr class="memdesc:af1498fa2514423f81fc30a3c67c694fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if the subspaces represented by the children of a node can overlap. <a href="#af1498fa2514423f81fc30a3c67c694fb">More...</a><br /></td></tr>
<tr class="separator:af1498fa2514423f81fc30a3c67c694fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f47cb87cdee54e84617d9ac49d6c6cd"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#a4f47cb87cdee54e84617d9ac49d6c6cd">HasSelfChildren</a> = false</td></tr>
<tr class="memdesc:a4f47cb87cdee54e84617d9ac49d6c6cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if the points contained in the first child of a node (Child(0)) are also contained in that node. <a href="#a4f47cb87cdee54e84617d9ac49d6c6cd">More...</a><br /></td></tr>
<tr class="separator:a4f47cb87cdee54e84617d9ac49d6c6cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6207c6ccffcc6ff51e60f5edbe40d05"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#ae6207c6ccffcc6ff51e60f5edbe40d05">RearrangesDataset</a> = false</td></tr>
<tr class="memdesc:ae6207c6ccffcc6ff51e60f5edbe40d05"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if the tree rearranges points in the dataset when it is built. <a href="#ae6207c6ccffcc6ff51e60f5edbe40d05">More...</a><br /></td></tr>
<tr class="separator:ae6207c6ccffcc6ff51e60f5edbe40d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13c453e1f11e7ac2724dcaf2a9c92243"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html#a13c453e1f11e7ac2724dcaf2a9c92243">UniqueNumDescendants</a> = true</td></tr>
<tr class="memdesc:a13c453e1f11e7ac2724dcaf2a9c92243"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is true if the NumDescendants() method doesn't include duplicated points. <a href="#a13c453e1f11e7ac2724dcaf2a9c92243">More...</a><br /></td></tr>
<tr class="separator:a13c453e1f11e7ac2724dcaf2a9c92243"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename TreeType&gt;<br />
class mlpack::tree::TreeTraits&lt; TreeType &gt;</h3>
<p>The <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html" title="The TreeTraits class provides compile-time information on the characteristics of a given tree type...">TreeTraits</a> class provides compile-time information on the characteristics of a given tree type. </p>
<p>These include traits such as whether or not a node knows the distance to its parent node, or whether or not the subspaces represented by children can overlap.</p>
<p>These traits can be used for static compile-time optimization:</p>
<div class="fragment"><div class="line"><span class="comment">// This if statement will be optimized out at compile time!</span></div><div class="line"><span class="keywordflow">if</span> (<a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#af1498fa2514423f81fc30a3c67c694fb">TreeTraits&lt;TreeType&gt;::HasOverlappingChildren</a> == <span class="keyword">false</span>)</div><div class="line">{</div><div class="line"> <span class="comment">// Do a simpler computation because no children overlap.</span></div><div class="line">}</div><div class="line"><span class="keywordflow">else</span></div><div class="line">{</div><div class="line"> <span class="comment">// Do the full, complex calculation.</span></div><div class="line">}</div></div><!-- fragment --><p>The traits can also be used in conjunction with SFINAE to write specialized versions of functions:</p>
<div class="fragment"><div class="line"><span class="keyword">template</span>&lt;<span class="keyword">typename</span> TreeType&gt;</div><div class="line"><span class="keywordtype">void</span> Compute(TreeType&amp; node,</div><div class="line"> <a class="code" href="namespacestd.html#ac774dbdf8ae769197167b2a8273462fc">std::enable_if_t</a>&lt;</div><div class="line"> <a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#ae6207c6ccffcc6ff51e60f5edbe40d05">TreeTraits&lt;TreeType&gt;::RearrangesDataset</a>&gt;*)</div><div class="line">{</div><div class="line"> <span class="comment">// Computation where special dataset-rearranging tree constructor is</span></div><div class="line"> <span class="comment">// called.</span></div><div class="line">}</div><div class="line"></div><div class="line"><span class="keyword">template</span>&lt;<span class="keyword">typename</span> TreeType&gt;</div><div class="line"><span class="keywordtype">void</span> Compute(TreeType&amp; node,</div><div class="line"> <a class="code" href="namespacestd.html#ac774dbdf8ae769197167b2a8273462fc">std::enable_if_t</a>&lt;</div><div class="line"> !<a class="code" href="classmlpack_1_1tree_1_1TreeTraits.html#ae6207c6ccffcc6ff51e60f5edbe40d05">TreeTraits&lt;TreeType&gt;::RearrangesDataset</a>&gt;*)</div><div class="line">{</div><div class="line"> <span class="comment">// Computation where normal tree constructor is called.</span></div><div class="line">}</div></div><!-- fragment --><p>In those two examples, the <a class="el" href="namespacestd.html#ac774dbdf8ae769197167b2a8273462fc">std::enable_if_t&lt;&gt;</a> class takes a boolean template parameter which allows that function to be called when the boolean is true.</p>
<p>Each trait must be a static const value and not a function; only const values can be used as template parameters (or constexprs can be used too). By default (the unspecialized implementation of <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html" title="The TreeTraits class provides compile-time information on the characteristics of a given tree type...">TreeTraits</a>), each parameter is set to make as few assumptions about the tree as possible; so, even if <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html" title="The TreeTraits class provides compile-time information on the characteristics of a given tree type...">TreeTraits</a> is not specialized for a particular tree type, tree-based algorithms should still work.</p>
<p>When you write your own tree, you must specialize the <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html" title="The TreeTraits class provides compile-time information on the characteristics of a given tree type...">TreeTraits</a> class to your tree type and set the corresponding values appropriately. See <a class="el" href="binary__space__tree_2traits_8hpp.html">mlpack/core/tree/binary_space_tree/traits.hpp</a> for an example. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00077">77</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af012af0a98e4dd36c2754cf1dbb202f0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::BinaryTree = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if the tree always has only two children. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00110">110</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4751f17406c9202f3c0228e6307dd22f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::FirstPointIsCentroid = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if the first point of each node is the centroid of its bound. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00094">94</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab386d6cc4c474b5201cb94005100c6f2"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::HasDuplicatedPoints = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if a point can be included in more than one node. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00089">89</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af1498fa2514423f81fc30a3c67c694fb"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::HasOverlappingChildren = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if the subspaces represented by the children of a node can overlap. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00084">84</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4f47cb87cdee54e84617d9ac49d6c6cd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::HasSelfChildren = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if the points contained in the first child of a node (Child(0)) are also contained in that node. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00100">100</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae6207c6ccffcc6ff51e60f5edbe40d05"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::RearrangesDataset = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if the tree rearranges points in the dataset when it is built. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00105">105</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a13c453e1f11e7ac2724dcaf2a9c92243"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TreeType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmlpack_1_1tree_1_1TreeTraits.html">mlpack::tree::TreeTraits</a>&lt; TreeType &gt;::UniqueNumDescendants = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is true if the NumDescendants() method doesn't include duplicated points. </p>
<p>Definition at line <a class="el" href="tree__traits_8hpp_source.html#l00116">116</a> of file <a class="el" href="tree__traits_8hpp_source.html">tree_traits.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mlpack/core/tree/<a class="el" href="tree__traits_8hpp_source.html">tree_traits.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