127 lines
18 KiB
HTML
127 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: src/mlpack/methods/emst/edge_pair.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_88d49b0062d70fa894a1612206b4da93.html">emst</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">edge_pair.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="edge__pair_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="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef MLPACK_METHODS_EMST_EDGE_PAIR_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define MLPACK_METHODS_EMST_EDGE_PAIR_HPP</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="union__find_8hpp.html">union_find.hpp</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>emst {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1emst_1_1EdgePair.html">EdgePair</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a3a6115b30e1a310af63384ac12b43369"> 32</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a3a6115b30e1a310af63384ac12b43369">lesser</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a9954245eeaee9bfdccbd8887efcf5c0f"> 34</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a9954245eeaee9bfdccbd8887efcf5c0f">greater</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a29c560b799202adef6c14552a1b780b4"> 36</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a29c560b799202adef6c14552a1b780b4">distance</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#ac5a7ffc244035a7b242462e98aa34444"> 45</a></span>  <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#ac5a7ffc244035a7b242462e98aa34444">EdgePair</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> lesser, <span class="keyword">const</span> <span class="keywordtype">size_t</span> greater, <span class="keyword">const</span> <span class="keywordtype">double</span> dist) :</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  lesser(lesser), greater(greater), distance(dist)</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>  <a class="code" href="classmlpack_1_1Log.html#a894b6a6ce578301d1d4404416e8496d3">Log::Assert</a>(lesser != greater,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="stringliteral">"EdgePair::EdgePair(): indices cannot be equal."</span>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a43b71576e25a72c45f451076a44a856e"> 53</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a43b71576e25a72c45f451076a44a856e">Lesser</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a3a6115b30e1a310af63384ac12b43369">lesser</a>; }</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#aa179dd921f7fdeea35a4bceb4c30e670"> 55</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#aa179dd921f7fdeea35a4bceb4c30e670">Lesser</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a3a6115b30e1a310af63384ac12b43369">lesser</a>; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#acbb6304d2a22301356004696a2b1ff21"> 58</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#acbb6304d2a22301356004696a2b1ff21">Greater</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a9954245eeaee9bfdccbd8887efcf5c0f">greater</a>; }</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a165595101b3e718b72fe2dd62e0f9661"> 60</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a165595101b3e718b72fe2dd62e0f9661">Greater</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a9954245eeaee9bfdccbd8887efcf5c0f">greater</a>; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a918f41cd4baf3c59e60ece151600659f"> 63</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a918f41cd4baf3c59e60ece151600659f">Distance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a29c560b799202adef6c14552a1b780b4">distance</a>; }</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmlpack_1_1emst_1_1EdgePair.html#a0164b4a0725258c9e72bfebae86146fe"> 65</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a0164b4a0725258c9e72bfebae86146fe">Distance</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1emst_1_1EdgePair.html#a29c560b799202adef6c14552a1b780b4">distance</a>; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> }; <span class="comment">// class EdgePair</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace emst</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#endif // MLPACK_METHODS_EMST_EDGE_PAIR_HPP</span></div><div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html">mlpack::emst::EdgePair</a></div><div class="ttdoc">An edge pair is simply two indices and a distance. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00028">edge_pair.hpp:28</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_1emst_1_1EdgePair_html_a165595101b3e718b72fe2dd62e0f9661"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a165595101b3e718b72fe2dd62e0f9661">mlpack::emst::EdgePair::Greater</a></div><div class="ttdeci">size_t & Greater()</div><div class="ttdoc">Modify the greater index. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00060">edge_pair.hpp:60</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_a43b71576e25a72c45f451076a44a856e"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a43b71576e25a72c45f451076a44a856e">mlpack::emst::EdgePair::Lesser</a></div><div class="ttdeci">size_t Lesser() const </div><div class="ttdoc">Get the lesser index. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00053">edge_pair.hpp:53</a></div></div>
|
|
<div class="ttc" id="union__find_8hpp_html"><div class="ttname"><a href="union__find_8hpp.html">union_find.hpp</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_1Log_html_a894b6a6ce578301d1d4404416e8496d3"><div class="ttname"><a href="classmlpack_1_1Log.html#a894b6a6ce578301d1d4404416e8496d3">mlpack::Log::Assert</a></div><div class="ttdeci">static void Assert(bool condition, const std::string &message="Assert Failed.")</div><div class="ttdoc">Checks if the specified condition is true. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_a9954245eeaee9bfdccbd8887efcf5c0f"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a9954245eeaee9bfdccbd8887efcf5c0f">mlpack::emst::EdgePair::greater</a></div><div class="ttdeci">size_t greater</div><div class="ttdoc">Greater index. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00034">edge_pair.hpp:34</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_ac5a7ffc244035a7b242462e98aa34444"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#ac5a7ffc244035a7b242462e98aa34444">mlpack::emst::EdgePair::EdgePair</a></div><div class="ttdeci">EdgePair(const size_t lesser, const size_t greater, const double dist)</div><div class="ttdoc">Initialize an EdgePair with two indices and a distance. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00045">edge_pair.hpp:45</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_acbb6304d2a22301356004696a2b1ff21"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#acbb6304d2a22301356004696a2b1ff21">mlpack::emst::EdgePair::Greater</a></div><div class="ttdeci">size_t Greater() const </div><div class="ttdoc">Get the greater index. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00058">edge_pair.hpp:58</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_a0164b4a0725258c9e72bfebae86146fe"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a0164b4a0725258c9e72bfebae86146fe">mlpack::emst::EdgePair::Distance</a></div><div class="ttdeci">double & Distance()</div><div class="ttdoc">Modify the distance. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00065">edge_pair.hpp:65</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_a3a6115b30e1a310af63384ac12b43369"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a3a6115b30e1a310af63384ac12b43369">mlpack::emst::EdgePair::lesser</a></div><div class="ttdeci">size_t lesser</div><div class="ttdoc">Lesser index. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00032">edge_pair.hpp:32</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_a918f41cd4baf3c59e60ece151600659f"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a918f41cd4baf3c59e60ece151600659f">mlpack::emst::EdgePair::Distance</a></div><div class="ttdeci">double Distance() const </div><div class="ttdoc">Get the distance. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00063">edge_pair.hpp:63</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_aa179dd921f7fdeea35a4bceb4c30e670"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#aa179dd921f7fdeea35a4bceb4c30e670">mlpack::emst::EdgePair::Lesser</a></div><div class="ttdeci">size_t & Lesser()</div><div class="ttdoc">Modify the lesser index. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00055">edge_pair.hpp:55</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1emst_1_1EdgePair_html_a29c560b799202adef6c14552a1b780b4"><div class="ttname"><a href="classmlpack_1_1emst_1_1EdgePair.html#a29c560b799202adef6c14552a1b780b4">mlpack::emst::EdgePair::distance</a></div><div class="ttdeci">double distance</div><div class="ttdoc">Distance between two indices. </div><div class="ttdef"><b>Definition:</b> <a href="edge__pair_8hpp_source.html#l00036">edge_pair.hpp:36</a></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>
|