323 lines
17 KiB
HTML
323 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: mlpack::tree::RPlusPlusTreeSplitPolicy 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
|
|
 <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 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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_1RPlusPlusTreeSplitPolicy.html">RPlusPlusTreeSplitPolicy</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mlpack::tree::RPlusPlusTreeSplitPolicy Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The <a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html" title="The RPlusPlusTreeSplitPolicy helps to determine the subtree into which we should insert a child of an...">RPlusPlusTreeSplitPolicy</a> helps to determine the subtree into which we should insert a child of an intermediate node that is being split.
|
|
<a href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:acae4089145112883f94c86da38a1b264"><td class="memTemplParams" colspan="2">template<typename TreeType > </td></tr>
|
|
<tr class="memitem:acae4089145112883f94c86da38a1b264"><td class="memTemplItemLeft" align="right" valign="top">static const <a class="el" href="classmlpack_1_1bound_1_1HRectBound.html">bound::HRectBound</a>< <a class="el" href="namespacemlpack_1_1metric.html#a012695bde5dbf7ded7f7a180b5f3f512">metric::EuclideanDistance</a>, typename TreeType::ElemType > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#acae4089145112883f94c86da38a1b264">Bound</a> (const TreeType &node)</td></tr>
|
|
<tr class="memdesc:acae4089145112883f94c86da38a1b264"><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum bounding rectangle of the node. <a href="#acae4089145112883f94c86da38a1b264">More...</a><br /></td></tr>
|
|
<tr class="separator:acae4089145112883f94c86da38a1b264"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a265f15b1d42a885ec28ba1f9ad74e260"><td class="memTemplParams" colspan="2">template<typename TreeType > </td></tr>
|
|
<tr class="memitem:a265f15b1d42a885ec28ba1f9ad74e260"><td class="memTemplItemLeft" align="right" valign="top">static int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#a265f15b1d42a885ec28ba1f9ad74e260">GetSplitPolicy</a> (const TreeType &child, const size_t axis, const typename TreeType::ElemType cut)</td></tr>
|
|
<tr class="memdesc:a265f15b1d42a885ec28ba1f9ad74e260"><td class="mdescLeft"> </td><td class="mdescRight">This method returns SplitRequired if a child of an intermediate node should be split, AssignToFirstTree if the child should be inserted to the first subtree, AssignToSecondTree if the child should be inserted to the second subtree. <a href="#a265f15b1d42a885ec28ba1f9ad74e260">More...</a><br /></td></tr>
|
|
<tr class="separator:a265f15b1d42a885ec28ba1f9ad74e260"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a0691114b4bc83a127ccd9c0ba02bcb36"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#a0691114b4bc83a127ccd9c0ba02bcb36">AssignToFirstTree</a> = 1</td></tr>
|
|
<tr class="memdesc:a0691114b4bc83a127ccd9c0ba02bcb36"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that the child should be inserted to the first subtree. <a href="#a0691114b4bc83a127ccd9c0ba02bcb36">More...</a><br /></td></tr>
|
|
<tr class="separator:a0691114b4bc83a127ccd9c0ba02bcb36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a839598fdb62d954076fa14d1cc2201e8"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#a839598fdb62d954076fa14d1cc2201e8">AssignToSecondTree</a> = 2</td></tr>
|
|
<tr class="memdesc:a839598fdb62d954076fa14d1cc2201e8"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that the child should be inserted to the second subtree. <a href="#a839598fdb62d954076fa14d1cc2201e8">More...</a><br /></td></tr>
|
|
<tr class="separator:a839598fdb62d954076fa14d1cc2201e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbbe2c89f7118b0bce7efeb124acb80a"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#afbbe2c89f7118b0bce7efeb124acb80a">SplitRequired</a> = 0</td></tr>
|
|
<tr class="memdesc:afbbe2c89f7118b0bce7efeb124acb80a"><td class="mdescLeft"> </td><td class="mdescRight">Indicate that the child should be split. <a href="#afbbe2c89f7118b0bce7efeb124acb80a">More...</a><br /></td></tr>
|
|
<tr class="separator:afbbe2c89f7118b0bce7efeb124acb80a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html" title="The RPlusPlusTreeSplitPolicy helps to determine the subtree into which we should insert a child of an...">RPlusPlusTreeSplitPolicy</a> helps to determine the subtree into which we should insert a child of an intermediate node that is being split. </p>
|
|
<p>This class is designed for the R++ tree. </p>
|
|
|
|
<p>Definition at line <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00025">25</a> of file <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="acae4089145112883f94c86da38a1b264"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TreeType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static const <a class="el" href="classmlpack_1_1bound_1_1HRectBound.html">bound::HRectBound</a><<a class="el" href="namespacemlpack_1_1metric.html#a012695bde5dbf7ded7f7a180b5f3f512">metric::EuclideanDistance</a>, typename TreeType::ElemType>& mlpack::tree::RPlusPlusTreeSplitPolicy::Bound </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const TreeType & </td>
|
|
<td class="paramname"><em>node</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the maximum bounding rectangle of the node. </p>
|
|
<p>This method should always return the bound that is used for the decision-making in <a class="el" href="classmlpack_1_1tree_1_1RPlusPlusTreeSplitPolicy.html#a265f15b1d42a885ec28ba1f9ad74e260" title="This method returns SplitRequired if a child of an intermediate node should be split, AssignToFirstTree if the child should be inserted to the first subtree, AssignToSecondTree if the child should be inserted to the second subtree. ">GetSplitPolicy()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">node</td><td>The node whose bound is requested. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00070">70</a> of file <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a265f15b1d42a885ec28ba1f9ad74e260"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TreeType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int mlpack::tree::RPlusPlusTreeSplitPolicy::GetSplitPolicy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const TreeType & </td>
|
|
<td class="paramname"><em>child</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const size_t </td>
|
|
<td class="paramname"><em>axis</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const typename TreeType::ElemType </td>
|
|
<td class="paramname"><em>cut</em> </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 class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This method returns SplitRequired if a child of an intermediate node should be split, AssignToFirstTree if the child should be inserted to the first subtree, AssignToSecondTree if the child should be inserted to the second subtree. </p>
|
|
<p>The method makes desicion according to the maximum bounding rectangle of the child, the axis along which the intermediate node is being split and the coordinate at which the node is being split.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">child</td><td>A child of the node that is being split. </td></tr>
|
|
<tr><td class="paramname">axis</td><td>The axis along which the node is being split. </td></tr>
|
|
<tr><td class="paramname">cut</td><td>The coordinate at which the node is being split. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00048">48</a> of file <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a>.</p>
|
|
|
|
<p>References <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00029">SplitRequired</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a0691114b4bc83a127ccd9c0ba02bcb36"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int mlpack::tree::RPlusPlusTreeSplitPolicy::AssignToFirstTree = 1</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>Indicate that the child should be inserted to the first subtree. </p>
|
|
|
|
<p>Definition at line <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00031">31</a> of file <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a839598fdb62d954076fa14d1cc2201e8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int mlpack::tree::RPlusPlusTreeSplitPolicy::AssignToSecondTree = 2</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>Indicate that the child should be inserted to the second subtree. </p>
|
|
|
|
<p>Definition at line <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00033">33</a> of file <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afbbe2c89f7118b0bce7efeb124acb80a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const int mlpack::tree::RPlusPlusTreeSplitPolicy::SplitRequired = 0</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>Indicate that the child should be split. </p>
|
|
|
|
<p>Definition at line <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00029">29</a> of file <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html#l00048">GetSplitPolicy()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/mlpack/core/tree/rectangle_tree/<a class="el" href="r__plus__plus__tree__split__policy_8hpp_source.html">r_plus_plus_tree_split_policy.hpp</a></li>
|
|
</ul>
|
|
</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>
|