124 lines
20 KiB
HTML
124 lines
20 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/methods/dbscan/dbscan.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
|
|
 <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><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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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_3cfbf900288ec2fe8dd2c2c8482f216e.html">methods</a></li><li class="navelem"><a class="el" href="dir_9706a54a818a8a8f60d990f75cc3c60c.html">dbscan</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">dbscan.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="dbscan_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> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef MLPACK_METHODS_DBSCAN_DBSCAN_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define MLPACK_METHODS_DBSCAN_DBSCAN_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <<a class="code" href="core_8hpp.html">mlpack/core.hpp</a>></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <<a class="code" href="range__search_8hpp.html">mlpack/methods/range_search/range_search.hpp</a>></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="random__point__selection_8hpp.html">random_point_selection.hpp</a>"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <boost/dynamic_bitset.hpp></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="namespacemlpack_1_1dbscan.html"> 17</a></span> <span class="keyword">namespace </span>dbscan {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span><<span class="keyword">typename</span> RangeSearchType = range::RangeSearch<>,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">typename</span> Po<span class="keywordtype">int</span>SelectionPolicy = RandomPo<span class="keywordtype">int</span>Selection></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classmlpack_1_1dbscan_1_1DBSCAN.html"> 46</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html">DBSCAN</a></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a96f5c29a196bdfe1196f4aff882509a7">DBSCAN</a>(<span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a17c67662e8349108561b2e0404b98f41">epsilon</a>,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a7b5ed90af8fc7fad58d4a70edca60933">minPoints</a>,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  RangeSearchType <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a327125b2edf34c005f43d0642d306879">rangeSearch</a> = RangeSearchType(),</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  PointSelectionPolicy <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a20ad4ad8d5aa72869a1a677d18335119">pointSelector</a> = PointSelectionPolicy());</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a800a24ccb55712c169e44d13750d8f06">Cluster</a>(<span class="keyword">const</span> MatType& data,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  arma::mat& centroids);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a800a24ccb55712c169e44d13750d8f06">Cluster</a>(<span class="keyword">const</span> MatType& data,</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  arma::Row<size_t>& assignments);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a800a24ccb55712c169e44d13750d8f06">Cluster</a>(<span class="keyword">const</span> MatType& data,</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  arma::Row<size_t>& assignments,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  arma::mat& centroids);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a17c67662e8349108561b2e0404b98f41"> 104</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a17c67662e8349108561b2e0404b98f41">epsilon</a>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a7b5ed90af8fc7fad58d4a70edca60933"> 108</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a7b5ed90af8fc7fad58d4a70edca60933">minPoints</a>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a327125b2edf34c005f43d0642d306879"> 111</a></span>  RangeSearchType <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a327125b2edf34c005f43d0642d306879">rangeSearch</a>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a20ad4ad8d5aa72869a1a677d18335119"> 114</a></span>  PointSelectionPolicy <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a20ad4ad8d5aa72869a1a677d18335119">pointSelector</a>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">template</span><<span class="keyword">typename</span> MatType></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1dbscan_1_1DBSCAN.html#a2fb7ebf28d845367dcbedbc8fd1a6a8a">ProcessPoint</a>(<span class="keyword">const</span> MatType& data,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  boost::dynamic_bitset<>& unvisited,</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> index,</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  arma::Row<size_t>& assignments,</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> currentCluster,</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">const</span> std::vector<std::vector<size_t>>& neighbors,</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">const</span> std::vector<std::vector<double>>& distances,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> topLevel = <span class="keyword">true</span>);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> };</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> } <span class="comment">// namespace dbscan</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="preprocessor">#include "dbscan_impl.hpp"</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="range__search_8hpp_html"><div class="ttname"><a href="range__search_8hpp.html">range_search.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html">mlpack::dbscan::DBSCAN</a></div><div class="ttdoc">DBSCAN (Density-Based Spatial Clustering of Applications with Noise) is a clustering technique descri...</div><div class="ttdef"><b>Definition:</b> <a href="dbscan_8hpp_source.html#l00046">dbscan.hpp:46</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html_a17c67662e8349108561b2e0404b98f41"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a17c67662e8349108561b2e0404b98f41">mlpack::dbscan::DBSCAN::epsilon</a></div><div class="ttdeci">double epsilon</div><div class="ttdoc">Maximum distance between two points to be part of same cluster. </div><div class="ttdef"><b>Definition:</b> <a href="dbscan_8hpp_source.html#l00104">dbscan.hpp:104</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html_a20ad4ad8d5aa72869a1a677d18335119"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a20ad4ad8d5aa72869a1a677d18335119">mlpack::dbscan::DBSCAN::pointSelector</a></div><div class="ttdeci">PointSelectionPolicy pointSelector</div><div class="ttdoc">Instantiated point selection policy. </div><div class="ttdef"><b>Definition:</b> <a href="dbscan_8hpp_source.html#l00114">dbscan.hpp:114</a></div></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_1dbscan_1_1DBSCAN_html_a2fb7ebf28d845367dcbedbc8fd1a6a8a"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a2fb7ebf28d845367dcbedbc8fd1a6a8a">mlpack::dbscan::DBSCAN::ProcessPoint</a></div><div class="ttdeci">size_t ProcessPoint(const MatType &data, boost::dynamic_bitset<> &unvisited, const size_t index, arma::Row< size_t > &assignments, const size_t currentCluster, const std::vector< std::vector< size_t >> &neighbors, const std::vector< std::vector< double >> &distances, const bool topLevel=true)</div><div class="ttdoc">This function processes the point at index. </div></div>
|
|
<div class="ttc" id="random__point__selection_8hpp_html"><div class="ttname"><a href="random__point__selection_8hpp.html">random_point_selection.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html_a800a24ccb55712c169e44d13750d8f06"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a800a24ccb55712c169e44d13750d8f06">mlpack::dbscan::DBSCAN::Cluster</a></div><div class="ttdeci">size_t Cluster(const MatType &data, arma::mat &centroids)</div><div class="ttdoc">Performs DBSCAN clustering on the data, returning number of clusters and also the centroid of each cl...</div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html_a327125b2edf34c005f43d0642d306879"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a327125b2edf34c005f43d0642d306879">mlpack::dbscan::DBSCAN::rangeSearch</a></div><div class="ttdeci">RangeSearchType rangeSearch</div><div class="ttdoc">Instantiated range search policy. </div><div class="ttdef"><b>Definition:</b> <a href="dbscan_8hpp_source.html#l00111">dbscan.hpp:111</a></div></div>
|
|
<div class="ttc" id="core_8hpp_html"><div class="ttname"><a href="core_8hpp.html">core.hpp</a></div><div class="ttdoc">Include all of the base components required to write MLPACK methods, and the main MLPACK Doxygen docu...</div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html_a7b5ed90af8fc7fad58d4a70edca60933"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a7b5ed90af8fc7fad58d4a70edca60933">mlpack::dbscan::DBSCAN::minPoints</a></div><div class="ttdeci">size_t minPoints</div><div class="ttdoc">Minimum number of points to be in the epsilon-neighborhood (including itself) for the point to be a c...</div><div class="ttdef"><b>Definition:</b> <a href="dbscan_8hpp_source.html#l00108">dbscan.hpp:108</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1dbscan_1_1DBSCAN_html_a96f5c29a196bdfe1196f4aff882509a7"><div class="ttname"><a href="classmlpack_1_1dbscan_1_1DBSCAN.html#a96f5c29a196bdfe1196f4aff882509a7">mlpack::dbscan::DBSCAN::DBSCAN</a></div><div class="ttdeci">DBSCAN(const double epsilon, const size_t minPoints, RangeSearchType rangeSearch=RangeSearchType(), PointSelectionPolicy pointSelector=PointSelectionPolicy())</div><div class="ttdoc">Construct the DBSCAN object with the given parameters. </div></div>
|
|
</div><!-- fragment --></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>
|