371 lines
18 KiB
HTML
371 lines
18 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::ProjVector 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_1ProjVector.html">ProjVector</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classmlpack_1_1tree_1_1ProjVector-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mlpack::tree::ProjVector Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html" title="ProjVector defines a general projection vector (not necessarily axis-parallel). ">ProjVector</a> defines a general projection vector (not necessarily axis-parallel).
|
|
<a href="classmlpack_1_1tree_1_1ProjVector.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:af05764dccc23aa0b911fa37efcda0f3d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html#af05764dccc23aa0b911fa37efcda0f3d">ProjVector</a> ()</td></tr>
|
|
<tr class="memdesc:af05764dccc23aa0b911fa37efcda0f3d"><td class="mdescLeft"> </td><td class="mdescRight">Empty Constructor. <a href="#af05764dccc23aa0b911fa37efcda0f3d">More...</a><br /></td></tr>
|
|
<tr class="separator:af05764dccc23aa0b911fa37efcda0f3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79d0df701e62af526fdb974b1144b499"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html#a79d0df701e62af526fdb974b1144b499">ProjVector</a> (const arma::vec &vect)</td></tr>
|
|
<tr class="memdesc:a79d0df701e62af526fdb974b1144b499"><td class="mdescLeft"> </td><td class="mdescRight">Create the projection vector based on the specified vector. <a href="#a79d0df701e62af526fdb974b1144b499">More...</a><br /></td></tr>
|
|
<tr class="separator:a79d0df701e62af526fdb974b1144b499"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69376a7b28ac68aa6b5ad5548641e4c4"><td class="memTemplParams" colspan="2">template<typename VecType > </td></tr>
|
|
<tr class="memitem:a69376a7b28ac68aa6b5ad5548641e4c4"><td class="memTemplItemLeft" align="right" valign="top">double </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html#a69376a7b28ac68aa6b5ad5548641e4c4">Project</a> (const VecType &point, typename <a class="el" href="namespacestd.html#ac774dbdf8ae769197167b2a8273462fc">std::enable_if_t</a>< <a class="el" href="structIsVector.html">IsVector</a>< VecType >::value > *=0) const </td></tr>
|
|
<tr class="memdesc:a69376a7b28ac68aa6b5ad5548641e4c4"><td class="mdescLeft"> </td><td class="mdescRight">Project the given point on the projection vector. <a href="#a69376a7b28ac68aa6b5ad5548641e4c4">More...</a><br /></td></tr>
|
|
<tr class="separator:a69376a7b28ac68aa6b5ad5548641e4c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6ca985c892a70acfb9f16b788681409"><td class="memTemplParams" colspan="2">template<typename MetricType , typename VecType > </td></tr>
|
|
<tr class="memitem:ad6ca985c892a70acfb9f16b788681409"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmlpack_1_1math_1_1RangeType.html">math::RangeType</a>< typename VecType::elem_type > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html#ad6ca985c892a70acfb9f16b788681409">Project</a> (const <a class="el" href="classmlpack_1_1bound_1_1BallBound.html">bound::BallBound</a>< MetricType, VecType > &bound) const </td></tr>
|
|
<tr class="memdesc:ad6ca985c892a70acfb9f16b788681409"><td class="mdescLeft"> </td><td class="mdescRight">Project the given ball bound on the projection vector. <a href="#ad6ca985c892a70acfb9f16b788681409">More...</a><br /></td></tr>
|
|
<tr class="separator:ad6ca985c892a70acfb9f16b788681409"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c86bd4c8ec6ba170635bd3b1c87e047"><td class="memTemplParams" colspan="2">template<typename Archive > </td></tr>
|
|
<tr class="memitem:a2c86bd4c8ec6ba170635bd3b1c87e047"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html#a2c86bd4c8ec6ba170635bd3b1c87e047">Serialize</a> (Archive &ar, const unsigned int)</td></tr>
|
|
<tr class="memdesc:a2c86bd4c8ec6ba170635bd3b1c87e047"><td class="mdescLeft"> </td><td class="mdescRight">Serialization. <a href="#a2c86bd4c8ec6ba170635bd3b1c87e047">More...</a><br /></td></tr>
|
|
<tr class="separator:a2c86bd4c8ec6ba170635bd3b1c87e047"><td class="memSeparator" colspan="2"> </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:a6dbd6d49ad4297767055230b6fcc2cfc"><td class="memItemLeft" align="right" valign="top">arma::vec </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1tree_1_1ProjVector.html#a6dbd6d49ad4297767055230b6fcc2cfc">projVect</a></td></tr>
|
|
<tr class="memdesc:a6dbd6d49ad4297767055230b6fcc2cfc"><td class="mdescLeft"> </td><td class="mdescRight">Projection vector. <a href="#a6dbd6d49ad4297767055230b6fcc2cfc">More...</a><br /></td></tr>
|
|
<tr class="separator:a6dbd6d49ad4297767055230b6fcc2cfc"><td class="memSeparator" colspan="2"> </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_1ProjVector.html" title="ProjVector defines a general projection vector (not necessarily axis-parallel). ">ProjVector</a> defines a general projection vector (not necessarily axis-parallel). </p>
|
|
|
|
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00091">91</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="af05764dccc23aa0b911fa37efcda0f3d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mlpack::tree::ProjVector::ProjVector </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Empty Constructor. </p>
|
|
|
|
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00100">100</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a79d0df701e62af526fdb974b1144b499"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mlpack::tree::ProjVector::ProjVector </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const arma::vec & </td>
|
|
<td class="paramname"><em>vect</em></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 vector. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vect</td><td>Vector to be considered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00109">109</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="a69376a7b28ac68aa6b5ad5548641e4c4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename VecType > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double mlpack::tree::ProjVector::Project </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const VecType & </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>< <a class="el" href="structIsVector.html">IsVector</a>< VecType >::value > * </td>
|
|
<td class="paramname"> = <code>0</code> </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#l00119">119</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6ca985c892a70acfb9f16b788681409"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename MetricType , typename VecType > </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><typename VecType::elem_type> mlpack::tree::ProjVector::Project </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classmlpack_1_1bound_1_1BallBound.html">bound::BallBound</a>< MetricType, VecType > & </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#l00132">132</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</a>.</p>
|
|
|
|
<p>References <a class="el" href="ballbound_8hpp_source.html#l00094">mlpack::bound::BallBound< MetricType, VecType >::Center()</a>, <a class="el" href="projection__vector_8hpp_source.html#l00045">mlpack::tree::AxisParallelProjVector::Project()</a>, and <a class="el" href="ballbound_8hpp_source.html#l00089">mlpack::bound::BallBound< MetricType, VecType >::Radius()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2c86bd4c8ec6ba170635bd3b1c87e047"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Archive > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mlpack::tree::ProjVector::Serialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Archive & </td>
|
|
<td class="paramname"><em>ar</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const unsigned </td>
|
|
<td class="paramname"><em>int</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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Serialization. </p>
|
|
|
|
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00145">145</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="a6dbd6d49ad4297767055230b6fcc2cfc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::vec mlpack::tree::ProjVector::projVect</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>Projection vector. </p>
|
|
|
|
<p>Definition at line <a class="el" href="projection__vector_8hpp_source.html#l00094">94</a> of file <a class="el" href="projection__vector_8hpp_source.html">projection_vector.hpp</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  <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>
|