Files
mlpack/doc/html/pca_8hpp.html
T

169 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: src/mlpack/methods/pca/pca.hpp File 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
&#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_473b7c10a53e85be883d242699eb1a8c.html">pca</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">pca.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
Include dependency graph for pca.hpp:</div>
<div class="dyncontent">
<div class="center"><img src="pca_8hpp__incl.png" border="0" usemap="#src_2mlpack_2methods_2pca_2pca_8hpp" alt=""/></div>
<map name="src_2mlpack_2methods_2pca_2pca_8hpp" id="src_2mlpack_2methods_2pca_2pca_8hpp">
<area shape="rect" id="node2" href="prereqs_8hpp.html" title="The core includes that mlpack expects; standard C++ includes and Armadillo. " alt="" coords="1135,199,1271,225"/>
<area shape="rect" id="node39" href="exact__svd__method_8hpp.html" title="mlpack/methods/pca\l/decomposition_policies\l/exact_svd_method.hpp" alt="" coords="1063,95,1225,151"/>
<area shape="rect" id="node19" href="serialization__shim_8hpp.html" title="mlpack/core/data/serialization\l_shim.hpp" alt="" coords="1475,273,1669,315"/>
<area shape="rect" id="node23" href="serialization__template__version_8hpp.html" title="mlpack/core/data/serialization\l_template_version.hpp" alt="" coords="2236,273,2431,315"/>
<area shape="rect" id="node25" href="arma__traits_8hpp.html" title="mlpack/core/util/arma\l_traits.hpp" alt="" coords="2652,273,2799,315"/>
<area shape="rect" id="node26" href="arma__config__check_8hpp.html" title="mlpack/core/util/arma\l_config_check.hpp" alt="" coords="2823,273,2969,315"/>
<area shape="rect" id="node28" href="log_8hpp.html" title="mlpack/core/util/log.hpp" alt="" coords="725,281,885,307"/>
<area shape="rect" id="node35" href="timers_8hpp.html" title="mlpack/core/util/timers.hpp" alt="" coords="960,281,1139,307"/>
<area shape="rect" id="node38" href="deprecated_8hpp.html" title="mlpack/core/util/deprecated.hpp" alt="" coords="2994,281,3201,307"/>
<area shape="rect" id="node20" href="sfinae__utility_8hpp.html" title="mlpack/core/util/sfinae\l_utility.hpp" alt="" coords="1631,363,1785,404"/>
<area shape="rect" id="node27" href="arma__config_8hpp.html" title="This is an autogenerated file which contains the configuration of Armadillo at the time mlpack was bu..." alt="" coords="2837,370,2955,397"/>
<area shape="rect" id="node31" href="prefixedoutstream_8hpp.html" title="prefixedoutstream.hpp" alt="" coords="898,370,1049,397"/>
<area shape="rect" id="node33" href="nulloutstream_8hpp.html" title="nulloutstream.hpp" alt="" coords="697,370,823,397"/>
</map>
</div>
</div>
<p><a href="pca_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1pca_1_1PCAType.html">mlpack::pca::PCAType&lt; DecompositionPolicy &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class implements principal components analysis (PCA). <a href="classmlpack_1_1pca_1_1PCAType.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemlpack"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack.html">mlpack</a></td></tr>
<tr class="memdesc:namespacemlpack"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linear algebra utility functions, generally performed on matrices or vectors. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemlpack_1_1pca"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack_1_1pca.html">mlpack::pca</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a89b48ac6fa2787f4d1f69c20ce3d5c20"><td class="memItemLeft" align="right" valign="top">typedef PCAType&lt; ExactSVDPolicy &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack_1_1pca.html#a89b48ac6fa2787f4d1f69c20ce3d5c20">mlpack::pca::PCA</a></td></tr>
<tr class="memdesc:a89b48ac6fa2787f4d1f69c20ce3d5c20"><td class="mdescLeft">&#160;</td><td class="mdescRight">3.0.0 TODO: break reverse-compatibility by changing <a class="el" href="classmlpack_1_1pca_1_1PCAType.html" title="This class implements principal components analysis (PCA). ">PCAType</a> to PCA. <a href="namespacemlpack_1_1pca.html#a89b48ac6fa2787f4d1f69c20ce3d5c20">More...</a><br /></td></tr>
<tr class="separator:a89b48ac6fa2787f4d1f69c20ce3d5c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Ajinkya Kale </dd>
<dd>
Ryan Curtin </dd>
<dd>
Marcus Edel</dd></dl>
<p>Defines the PCA class to perform Principal Components Analysis on the specified data set. There are many variations on how to do this, so template parameters allow the selection of different techniques.</p>
<p>mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see <a href="http://www.opensource.org/licenses/BSD-3-Clause">http://www.opensource.org/licenses/BSD-3-Clause</a> for more information. </p>
<p>Definition in file <a class="el" href="pca_8hpp_source.html">pca.hpp</a>.</p>
</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>