Files
mlpack/doc/html/sample.html
T

127 lines
10 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: Simple Sample mlpack Programs</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 class="current"><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><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>
<!-- 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><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Simple Sample mlpack Programs </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="sampleintro"></a>
Introduction</h1>
<p>On this page, several simple mlpack examples are contained, in increasing order of complexity. If you compile from the command-line, be sure that your compiler is in C++11 mode. With gcc and clang, this can be accomplished by adding the <code>-std=c++11</code> option.</p>
<h1><a class="anchor" id="covariance"></a>
Covariance Computation</h1>
<p>A simple program to compute the covariance of a data matrix ("data.csv"), assuming that the data is already centered, and save it to file.</p>
<div class="fragment"><div class="line"><span class="comment">// Includes all relevant components of mlpack.</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="core_8hpp.html">mlpack/core.hpp</a>&gt;</span></div><div class="line"></div><div class="line"><span class="comment">// Convenience.</span></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacemlpack.html">mlpack</a>;</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main()</div><div class="line">{</div><div class="line"> <span class="comment">// First, load the data.</span></div><div class="line"> arma::mat data;</div><div class="line"> <span class="comment">// Use data::Load() which transposes the matrix.</span></div><div class="line"> <a class="code" href="namespacemlpack_1_1data.html#a19805d6585ac8b0be7c4e4b7f081977c">data::Load</a>(<span class="stringliteral">&quot;data.csv&quot;</span>, data, <span class="keyword">true</span>);</div><div class="line"></div><div class="line"> <span class="comment">// Now compute the covariance. We assume that the data is already centered.</span></div><div class="line"> <span class="comment">// Remember, because the matrix is column-major, the covariance operation is</span></div><div class="line"> <span class="comment">// transposed.</span></div><div class="line"> arma::mat cov = data * trans(data) / data.n_cols;</div><div class="line"></div><div class="line"> <span class="comment">// Save the output.</span></div><div class="line"> <a class="code" href="namespacemlpack_1_1data.html#a16bc794b14db0ab126595b19a32a5bc0">data::Save</a>(<span class="stringliteral">&quot;cov.csv&quot;</span>, cov, <span class="keyword">true</span>);</div><div class="line">}</div></div><!-- fragment --><h1><a class="anchor" id="nn"></a>
Nearest Neighbor</h1>
<p>This simple program uses the <a class="el" href="classmlpack_1_1neighbor_1_1NeighborSearch.html" title="The NeighborSearch class is a template class for performing distance-based neighbor searches...">mlpack::neighbor::NeighborSearch</a> object to find the nearest neighbor of each point in a dataset using the L1 metric, and then print the index of the neighbor and the distance of it to stdout.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="core_8hpp.html">mlpack/core.hpp</a>&gt;</span></div><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="neighbor__search_8hpp.html">mlpack/methods/neighbor_search/neighbor_search.hpp</a>&gt;</span></div><div class="line"></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacemlpack.html">mlpack</a>;</div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacemlpack_1_1neighbor.html">mlpack::neighbor</a>; <span class="comment">// NeighborSearch and NearestNeighborSort</span></div><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacemlpack_1_1metric.html">mlpack::metric</a>; <span class="comment">// ManhattanDistance</span></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main()</div><div class="line">{</div><div class="line"> <span class="comment">// Load the data from data.csv (hard-coded). Use CLI for simple command-line</span></div><div class="line"> <span class="comment">// parameter handling.</span></div><div class="line"> arma::mat data;</div><div class="line"> <a class="code" href="namespacemlpack_1_1data.html#a19805d6585ac8b0be7c4e4b7f081977c">data::Load</a>(<span class="stringliteral">&quot;data.csv&quot;</span>, data, <span class="keyword">true</span>);</div><div class="line"></div><div class="line"> <span class="comment">// Use templates to specify that we want a NeighborSearch object which uses</span></div><div class="line"> <span class="comment">// the Manhattan distance.</span></div><div class="line"> <a class="code" href="classmlpack_1_1neighbor_1_1NeighborSearch.html">NeighborSearch&lt;NearestNeighborSort, ManhattanDistance&gt;</a> nn(data);</div><div class="line"></div><div class="line"> <span class="comment">// Create the object we will store the nearest neighbors in.</span></div><div class="line"> arma::Mat&lt;size_t&gt; neighbors;</div><div class="line"> arma::mat distances; <span class="comment">// We need to store the distance too.</span></div><div class="line"></div><div class="line"> <span class="comment">// Compute the neighbors.</span></div><div class="line"> nn.Search(1, neighbors, distances);</div><div class="line"></div><div class="line"> <span class="comment">// Write each neighbor and distance using Log.</span></div><div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; neighbors.n_elem; ++i)</div><div class="line"> {</div><div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Nearest neighbor of point &quot;</span> &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot; is point &quot;</span></div><div class="line"> &lt;&lt; neighbors[i] &lt;&lt; <span class="stringliteral">&quot; and the distance is &quot;</span> &lt;&lt; distances[i] &lt;&lt; <span class="stringliteral">&quot;.\n&quot;</span>;</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --><h1><a class="anchor" id="other"></a>
Other examples</h1>
<p>For more complex examples, it is useful to refer to the main executables:</p>
<ul>
<li>methods/neighbor_search/knn_main.cpp</li>
<li>methods/neighbor_search/kfn_main.cpp</li>
<li>methods/emst/emst_main.cpp</li>
<li>methods/radical/radical_main.cpp</li>
<li>methods/nca/nca_main.cpp</li>
<li>methods/naive_bayes/nbc_main.cpp</li>
<li>methods/pca/pca_main.cpp</li>
<li>methods/lars/lars_main.cpp</li>
<li>methods/linear_regression/linear_regression_main.cpp</li>
<li>methods/gmm/gmm_main.cpp</li>
<li>methods/kmeans/kmeans_main.cpp </li>
</ul>
</div></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>