Files
mlpack/doc/html/kill__empty__clusters_8hpp_source.html
T

119 lines
14 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/kmeans/kill_empty_clusters.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
&#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><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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="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_92fef07ccd725ea5b5efef3c585f82fc.html">kmeans</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">kill_empty_clusters.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="kill__empty__clusters_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>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __MLPACK_METHODS_KMEANS_KILL_EMPTY_CLUSTERS_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define __MLPACK_METHODS_KMEANS_KILL_EMPTY_CLUSTERS_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>kmeans {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html"> 25</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html">KillEmptyClusters</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a9d86952920ecd0bd2e4ba96975632e30"> 29</a></span>&#160; <a class="code" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a9d86952920ecd0bd2e4ba96975632e30">KillEmptyClusters</a>() { }</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> MetricType, <span class="keyword">typename</span> MatType&gt;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a84fcee6efcec8c09c4bec3cf1148c94b"> 49</a></span>&#160; <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="prereqs_8hpp.html#ae8c57c7218a376f10cbdf0e50f1189ee">force_inline</a> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a84fcee6efcec8c09c4bec3cf1148c94b">EmptyCluster</a>(</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">const</span> MatType&amp; <span class="comment">/* data */</span>,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> emptyCluster,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">const</span> arma::mat&amp; <span class="comment">/* oldCentroids */</span>,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; arma::mat&amp; newCentroids,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; arma::Col&lt;size_t&gt;&amp; <span class="comment">/* clusterCounts */</span>,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; MetricType&amp; <span class="comment">/* metric */</span>,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> <span class="comment">/* iteration */</span>)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// Kill the empty cluster.</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; newCentroids.col(emptyCluster).fill(DBL_MAX);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> 0; <span class="comment">// No points were changed.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Archive&gt;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a9ca2c1a14acf22b34359debd4fe3c201"> 65</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a9ca2c1a14acf22b34359debd4fe3c201">Serialize</a>(Archive&amp; <span class="comment">/* ar */</span>, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="comment">/* version */</span>) { }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;} <span class="comment">// namespace kmeans</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="preprocessor">#endif</span></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="prereqs_8hpp_html"><div class="ttname"><a href="prereqs_8hpp.html">prereqs.hpp</a></div><div class="ttdoc">The core includes that mlpack expects; standard C++ includes and Armadillo. </div></div>
<div class="ttc" id="classmlpack_1_1kmeans_1_1KillEmptyClusters_html_a9ca2c1a14acf22b34359debd4fe3c201"><div class="ttname"><a href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a9ca2c1a14acf22b34359debd4fe3c201">mlpack::kmeans::KillEmptyClusters::Serialize</a></div><div class="ttdeci">void Serialize(Archive &amp;, const unsigned int)</div><div class="ttdoc">Serialize the empty cluster policy (nothing to do). </div><div class="ttdef"><b>Definition:</b> <a href="kill__empty__clusters_8hpp_source.html#l00065">kill_empty_clusters.hpp:65</a></div></div>
<div class="ttc" id="classmlpack_1_1kmeans_1_1KillEmptyClusters_html_a84fcee6efcec8c09c4bec3cf1148c94b"><div class="ttname"><a href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a84fcee6efcec8c09c4bec3cf1148c94b">mlpack::kmeans::KillEmptyClusters::EmptyCluster</a></div><div class="ttdeci">static force_inline size_t EmptyCluster(const MatType &amp;, const size_t emptyCluster, const arma::mat &amp;, arma::mat &amp;newCentroids, arma::Col&lt; size_t &gt; &amp;, MetricType &amp;, const size_t)</div><div class="ttdoc">This function sets an empty cluster found during k-means to all DBL_MAX (i.e. </div><div class="ttdef"><b>Definition:</b> <a href="kill__empty__clusters_8hpp_source.html#l00049">kill_empty_clusters.hpp:49</a></div></div>
<div class="ttc" id="prereqs_8hpp_html_ae8c57c7218a376f10cbdf0e50f1189ee"><div class="ttname"><a href="prereqs_8hpp.html#ae8c57c7218a376f10cbdf0e50f1189ee">force_inline</a></div><div class="ttdeci">#define force_inline</div><div class="ttdef"><b>Definition:</b> <a href="prereqs_8hpp_source.html#l00044">prereqs.hpp:44</a></div></div>
<div class="ttc" id="classmlpack_1_1kmeans_1_1KillEmptyClusters_html"><div class="ttname"><a href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html">mlpack::kmeans::KillEmptyClusters</a></div><div class="ttdoc">Policy which allows K-Means to &quot;kill&quot; empty clusters without any error being reported. </div><div class="ttdef"><b>Definition:</b> <a href="kill__empty__clusters_8hpp_source.html#l00025">kill_empty_clusters.hpp:25</a></div></div>
<div class="ttc" id="classmlpack_1_1kmeans_1_1KillEmptyClusters_html_a9d86952920ecd0bd2e4ba96975632e30"><div class="ttname"><a href="classmlpack_1_1kmeans_1_1KillEmptyClusters.html#a9d86952920ecd0bd2e4ba96975632e30">mlpack::kmeans::KillEmptyClusters::KillEmptyClusters</a></div><div class="ttdeci">KillEmptyClusters()</div><div class="ttdoc">Default constructor required by EmptyClusterPolicy policy. </div><div class="ttdef"><b>Definition:</b> <a href="kill__empty__clusters_8hpp_source.html#l00029">kill_empty_clusters.hpp:29</a></div></div>
</div><!-- fragment --></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>