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

391 lines
20 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::AxisParallelProjVector 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
&#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_1AxisParallelProjVector.html">AxisParallelProjVector</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classmlpack_1_1tree_1_1AxisParallelProjVector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mlpack::tree::AxisParallelProjVector Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html" title="AxisParallelProjVector defines an axis-parallel projection vector. ">AxisParallelProjVector</a> defines an axis-parallel projection vector.
<a href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6d57d0fc453c5cb1e8711c9ea39c28b9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#a6d57d0fc453c5cb1e8711c9ea39c28b9">AxisParallelProjVector</a> (size_t <a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#aa3557501be5cbf9b70821f3c88813bd2">dim</a>=0)</td></tr>
<tr class="memdesc:a6d57d0fc453c5cb1e8711c9ea39c28b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the projection vector based on the specified dimension. <a href="#a6d57d0fc453c5cb1e8711c9ea39c28b9">More...</a><br /></td></tr>
<tr class="separator:a6d57d0fc453c5cb1e8711c9ea39c28b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac13b4f6eebb1bbb7d8aacbb21fb76d74"><td class="memTemplParams" colspan="2">template&lt;typename VecType &gt; </td></tr>
<tr class="memitem:ac13b4f6eebb1bbb7d8aacbb21fb76d74"><td class="memTemplItemLeft" align="right" valign="top">double&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#ac13b4f6eebb1bbb7d8aacbb21fb76d74">Project</a> (const VecType &amp;point, typename <a class="el" href="namespacestd.html#ac774dbdf8ae769197167b2a8273462fc">std::enable_if_t</a>&lt; <a class="el" href="structIsVector.html">IsVector</a>&lt; VecType &gt;::value &gt; *=0) const </td></tr>
<tr class="memdesc:ac13b4f6eebb1bbb7d8aacbb21fb76d74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Project the given point on the projection vector. <a href="#ac13b4f6eebb1bbb7d8aacbb21fb76d74">More...</a><br /></td></tr>
<tr class="separator:ac13b4f6eebb1bbb7d8aacbb21fb76d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7cb323ae44b846c0e2424a51abbd7b9"><td class="memTemplParams" colspan="2">template&lt;typename MetricType , typename ElemType &gt; </td></tr>
<tr class="memitem:af7cb323ae44b846c0e2424a51abbd7b9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmlpack_1_1math_1_1RangeType.html">math::RangeType</a>&lt; ElemType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#af7cb323ae44b846c0e2424a51abbd7b9">Project</a> (const <a class="el" href="classmlpack_1_1bound_1_1HRectBound.html">bound::HRectBound</a>&lt; MetricType, ElemType &gt; &amp;bound) const </td></tr>
<tr class="memdesc:af7cb323ae44b846c0e2424a51abbd7b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Project the given hrect bound on the projection vector. <a href="#af7cb323ae44b846c0e2424a51abbd7b9">More...</a><br /></td></tr>
<tr class="separator:af7cb323ae44b846c0e2424a51abbd7b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58cd6030271d2cd1998f47c74dd86ce5"><td class="memTemplParams" colspan="2">template&lt;typename MetricType , typename VecType &gt; </td></tr>
<tr class="memitem:a58cd6030271d2cd1998f47c74dd86ce5"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmlpack_1_1math_1_1RangeType.html">math::RangeType</a>&lt; typename VecType::elem_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#a58cd6030271d2cd1998f47c74dd86ce5">Project</a> (const <a class="el" href="classmlpack_1_1bound_1_1BallBound.html">bound::BallBound</a>&lt; MetricType, VecType &gt; &amp;bound) const </td></tr>
<tr class="memdesc:a58cd6030271d2cd1998f47c74dd86ce5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Project the given ball bound on the projection vector. <a href="#a58cd6030271d2cd1998f47c74dd86ce5">More...</a><br /></td></tr>
<tr class="separator:a58cd6030271d2cd1998f47c74dd86ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b41a997cb894f8ebce1ff5e375a4d6f"><td class="memTemplParams" colspan="2">template&lt;typename Archive &gt; </td></tr>
<tr class="memitem:a5b41a997cb894f8ebce1ff5e375a4d6f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#a5b41a997cb894f8ebce1ff5e375a4d6f">Serialize</a> (Archive &amp;ar, const unsigned int)</td></tr>
<tr class="memdesc:a5b41a997cb894f8ebce1ff5e375a4d6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialization. <a href="#a5b41a997cb894f8ebce1ff5e375a4d6f">More...</a><br /></td></tr>
<tr class="separator:a5b41a997cb894f8ebce1ff5e375a4d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aa3557501be5cbf9b70821f3c88813bd2"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html#aa3557501be5cbf9b70821f3c88813bd2">dim</a></td></tr>
<tr class="memdesc:aa3557501be5cbf9b70821f3c88813bd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dimension considered. <a href="#aa3557501be5cbf9b70821f3c88813bd2">More...</a><br /></td></tr>
<tr class="separator:aa3557501be5cbf9b70821f3c88813bd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classmlpack_1_1tree_1_1AxisParallelProjVector.html" title="AxisParallelProjVector defines an axis-parallel projection vector. ">AxisParallelProjVector</a> defines an axis-parallel projection vector. </p>
<p>We can efficiently project points, simply analyzing a specific dimension. </p>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00024">24</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6d57d0fc453c5cb1e8711c9ea39c28b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mlpack::tree::AxisParallelProjVector::AxisParallelProjVector </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>dim</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the projection vector based on the specified dimension. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dim</td><td>Dimension to be considered. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00035">35</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac13b4f6eebb1bbb7d8aacbb21fb76d74"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VecType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double mlpack::tree::AxisParallelProjVector::Project </td>
<td>(</td>
<td class="paramtype">const VecType &amp;&#160;</td>
<td class="paramname"><em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename <a class="el" href="namespacestd.html#ac774dbdf8ae769197167b2a8273462fc">std::enable_if_t</a>&lt; <a class="el" href="structIsVector.html">IsVector</a>&lt; VecType &gt;::value &gt; *&#160;</td>
<td class="paramname"> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Project the given point on the projection vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">point</td><td>Point to be projected. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00045">45</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
<p>References <a class="el" href="projection__vector_8hpp_source.html#l00027">dim</a>.</p>
<p>Referenced by <a class="el" href="projection__vector_8hpp_source.html#l00132">mlpack::tree::ProjVector::Project()</a>.</p>
</div>
</div>
<a class="anchor" id="af7cb323ae44b846c0e2424a51abbd7b9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MetricType , typename ElemType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmlpack_1_1math_1_1RangeType.html">math::RangeType</a>&lt;ElemType&gt; mlpack::tree::AxisParallelProjVector::Project </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmlpack_1_1bound_1_1HRectBound.html">bound::HRectBound</a>&lt; MetricType, ElemType &gt; &amp;&#160;</td>
<td class="paramname"><em>bound</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Project the given hrect bound on the projection vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bound</td><td>Bound to be projected. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Range of projected values. </dd></dl>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00058">58</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
<p>References <a class="el" href="projection__vector_8hpp_source.html#l00027">dim</a>.</p>
</div>
</div>
<a class="anchor" id="a58cd6030271d2cd1998f47c74dd86ce5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename MetricType , typename VecType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmlpack_1_1math_1_1RangeType.html">math::RangeType</a>&lt;typename VecType::elem_type&gt; mlpack::tree::AxisParallelProjVector::Project </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmlpack_1_1bound_1_1BallBound.html">bound::BallBound</a>&lt; MetricType, VecType &gt; &amp;&#160;</td>
<td class="paramname"><em>bound</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Project the given ball bound on the projection vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bound</td><td>Bound to be projected. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Range of projected values. </dd></dl>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00071">71</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
<p>References <a class="el" href="projection__vector_8hpp_source.html#l00027">dim</a>.</p>
</div>
</div>
<a class="anchor" id="a5b41a997cb894f8ebce1ff5e375a4d6f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mlpack::tree::AxisParallelProjVector::Serialize </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>ar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned&#160;</td>
<td class="paramname"><em>int</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialization. </p>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00081">81</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
<p>References <a class="el" href="serialization__shim_8hpp_source.html#l00094">mlpack::data::CreateNVP()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa3557501be5cbf9b70821f3c88813bd2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mlpack::tree::AxisParallelProjVector::dim</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dimension considered. </p>
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00027">27</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
<p>Referenced by <a class="el" href="projection__vector_8hpp_source.html#l00045">Project()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mlpack/core/tree/space_split/<a class="el" href="projection__vector_8hpp_source.html">projection_vector.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