Files
mlpack/doc/html/kernel__pca_8hpp_source.html
T

125 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/kernel_pca/kernel_pca.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_d5ae1c28f4bc41f3d043610e8096d80a.html">kernel_pca</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">kernel_pca.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="kernel__pca_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="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_KERNEL_PCA_KERNEL_PCA_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_KERNEL_PCA_KERNEL_PCA_HPP</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</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="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="naive__method_8hpp.html">mlpack/methods/kernel_pca/kernel_rules/naive_method.hpp</a>&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="namespacemlpack_1_1kpca.html"> 21</a></span>&#160;<span class="keyword">namespace </span>kpca {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">template</span> &lt;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">typename</span> KernelType,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">typename</span> KernelRule = <a class="code" href="classmlpack_1_1kpca_1_1NaiveKernelRule.html">NaiveKernelRule&lt;KernelType&gt;</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;&gt;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html"> 40</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html">KernelPCA</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a3bb07d18fafeb4e01894be9b089415b4">KernelPCA</a>(<span class="keyword">const</span> KernelType <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ac51adc63f59a4735d1b91e19c934ea73">kernel</a> = KernelType(),</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad76d1209a1ff702ce391bc6b7e2ccb53">centerTransformedData</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a879bf80f5e30c27dd1d8acec37a39b70">Apply</a>(<span class="keyword">const</span> arma::mat&amp; data,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; arma::mat&amp; transformedData,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; arma::vec&amp; eigval,</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; arma::mat&amp; eigvec,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> newDimension);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a879bf80f5e30c27dd1d8acec37a39b70">Apply</a>(<span class="keyword">const</span> arma::mat&amp; data,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; arma::mat&amp; transformedData,</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; arma::vec&amp; eigval,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; arma::mat&amp; eigvec);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a879bf80f5e30c27dd1d8acec37a39b70">Apply</a>(<span class="keyword">const</span> arma::mat&amp; data,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; arma::mat&amp; transformedData,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; arma::vec&amp; eigval);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a879bf80f5e30c27dd1d8acec37a39b70">Apply</a>(arma::mat&amp; data, <span class="keyword">const</span> <span class="keywordtype">size_t</span> newDimension);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad8b8e3feebfffe23b229f460b8a62de6"> 110</a></span>&#160; <span class="keyword">const</span> KernelType&amp; <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad8b8e3feebfffe23b229f460b8a62de6">Kernel</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ac51adc63f59a4735d1b91e19c934ea73">kernel</a>; }</div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad94dfd24df17e16446e9d5b0061c9266"> 112</a></span>&#160; KernelType&amp; <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad94dfd24df17e16446e9d5b0061c9266">Kernel</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ac51adc63f59a4735d1b91e19c934ea73">kernel</a>; }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html#a3e913268a440d20301ea86d1d747c9f1"> 115</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a3e913268a440d20301ea86d1d747c9f1">CenterTransformedData</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad76d1209a1ff702ce391bc6b7e2ccb53">centerTransformedData</a>; }</div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html#a7657a4d834d273a90baeac80b428a428"> 117</a></span>&#160; <span class="keywordtype">bool</span>&amp; <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#a7657a4d834d273a90baeac80b428a428">CenterTransformedData</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad76d1209a1ff702ce391bc6b7e2ccb53">centerTransformedData</a>; }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html#ac51adc63f59a4735d1b91e19c934ea73"> 121</a></span>&#160; KernelType <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ac51adc63f59a4735d1b91e19c934ea73">kernel</a>;</div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad76d1209a1ff702ce391bc6b7e2ccb53"> 124</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1kpca_1_1KernelPCA.html#ad76d1209a1ff702ce391bc6b7e2ccb53">centerTransformedData</a>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;}; <span class="comment">// class KernelPCA</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;} <span class="comment">// namespace kpca</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment">// Include implementation.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="preprocessor">#include &quot;kernel_pca_impl.hpp&quot;</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="preprocessor">#endif // MLPACK_METHODS_KERNEL_PCA_KERNEL_PCA_HPP</span></div><div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_ac51adc63f59a4735d1b91e19c934ea73"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#ac51adc63f59a4735d1b91e19c934ea73">mlpack::kpca::KernelPCA::kernel</a></div><div class="ttdeci">KernelType kernel</div><div class="ttdoc">The instantiated kernel. </div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00121">kernel_pca.hpp:121</a></div></div>
<div class="ttc" id="naive__method_8hpp_html"><div class="ttname"><a href="naive__method_8hpp.html">naive_method.hpp</a></div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_a3bb07d18fafeb4e01894be9b089415b4"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#a3bb07d18fafeb4e01894be9b089415b4">mlpack::kpca::KernelPCA::KernelPCA</a></div><div class="ttdeci">KernelPCA(const KernelType kernel=KernelType(), const bool centerTransformedData=false)</div><div class="ttdoc">Construct the KernelPCA object, optionally passing a kernel. </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_1kpca_1_1NaiveKernelRule_html"><div class="ttname"><a href="classmlpack_1_1kpca_1_1NaiveKernelRule.html">mlpack::kpca::NaiveKernelRule</a></div><div class="ttdef"><b>Definition:</b> <a href="naive__method_8hpp_source.html#l00022">naive_method.hpp:22</a></div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_a7657a4d834d273a90baeac80b428a428"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#a7657a4d834d273a90baeac80b428a428">mlpack::kpca::KernelPCA::CenterTransformedData</a></div><div class="ttdeci">bool &amp; CenterTransformedData()</div><div class="ttdoc">Return whether or not the transformed data is centered. </div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00117">kernel_pca.hpp:117</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_1kpca_1_1KernelPCA_html_a879bf80f5e30c27dd1d8acec37a39b70"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#a879bf80f5e30c27dd1d8acec37a39b70">mlpack::kpca::KernelPCA::Apply</a></div><div class="ttdeci">void Apply(const arma::mat &amp;data, arma::mat &amp;transformedData, arma::vec &amp;eigval, arma::mat &amp;eigvec, const size_t newDimension)</div><div class="ttdoc">Apply Kernel Principal Components Analysis to the provided data set. </div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_ad76d1209a1ff702ce391bc6b7e2ccb53"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#ad76d1209a1ff702ce391bc6b7e2ccb53">mlpack::kpca::KernelPCA::centerTransformedData</a></div><div class="ttdeci">bool centerTransformedData</div><div class="ttdoc">If true, the data will be scaled (by standard deviation) when Apply() is run. </div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00124">kernel_pca.hpp:124</a></div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_ad94dfd24df17e16446e9d5b0061c9266"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#ad94dfd24df17e16446e9d5b0061c9266">mlpack::kpca::KernelPCA::Kernel</a></div><div class="ttdeci">KernelType &amp; Kernel()</div><div class="ttdoc">Modify the kernel. </div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00112">kernel_pca.hpp:112</a></div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_ad8b8e3feebfffe23b229f460b8a62de6"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#ad8b8e3feebfffe23b229f460b8a62de6">mlpack::kpca::KernelPCA::Kernel</a></div><div class="ttdeci">const KernelType &amp; Kernel() const </div><div class="ttdoc">Get the kernel. </div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00110">kernel_pca.hpp:110</a></div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html">mlpack::kpca::KernelPCA</a></div><div class="ttdoc">This class performs kernel principal components analysis (Kernel PCA), for a given kernel...</div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00040">kernel_pca.hpp:40</a></div></div>
<div class="ttc" id="classmlpack_1_1kpca_1_1KernelPCA_html_a3e913268a440d20301ea86d1d747c9f1"><div class="ttname"><a href="classmlpack_1_1kpca_1_1KernelPCA.html#a3e913268a440d20301ea86d1d747c9f1">mlpack::kpca::KernelPCA::CenterTransformedData</a></div><div class="ttdeci">bool CenterTransformedData() const </div><div class="ttdoc">Return whether or not the transformed data is centered. </div><div class="ttdef"><b>Definition:</b> <a href="kernel__pca_8hpp_source.html#l00115">kernel_pca.hpp:115</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>