mirror of
https://github.com/g-truc/glm.git
synced 2024-09-20 00:12:17 +00:00
133 lines
14 KiB
HTML
133 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>1.0.0 API documentation: 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>
|
|
<link href="doxygen.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="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">1.0.0 API documentation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></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_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_63ed049134a778d525e06b63afc2c979.html">Github</a></li><li class="navelem"><a class="el" href="dir_c98a9ac98258ab9f831b188d66361a70.html">g-truc</a></li><li class="navelem"><a class="el" href="dir_50f12b6ceb23d7f6adfb377a1ae8b006.html">glm</a></li><li class="navelem"><a class="el" href="dir_fca33f1b5115d46f42c670590789c0d2.html">glm</a></li><li class="navelem"><a class="el" href="dir_628fd60eb37daf5aa9a81e3983c640b7.html">gtx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">pca.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00698.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="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Dependency:</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include "../glm.hpp"</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include "../ext/scalar_relational.hpp"</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"># error "GLM: GLM_GTX_pca is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_pca extension included")</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</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> <span class="keyword">namespace </span>glm {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">template</span><length_t D, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00958.html#ga2d6dc3e25182cae243cdf55310059af0"> 59</a></span>  GLM_INLINE mat<D, D, T, Q> <a class="code" href="a00958.html#ga666383aa52036f00f3b66e4e7e56da3a">computeCovarianceMatrix</a>(vec<D, T, Q> <span class="keyword">const</span>* v, <span class="keywordtype">size_t</span> n);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">template</span><length_t D, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="a00958.html#gabfc7aba26da1eed6726f2484584f4077"> 66</a></span>  GLM_INLINE mat<D, D, T, Q> <a class="code" href="a00958.html#ga666383aa52036f00f3b66e4e7e56da3a">computeCovarianceMatrix</a>(vec<D, T, Q> <span class="keyword">const</span>* v, <span class="keywordtype">size_t</span> n, vec<D, T, Q> <span class="keyword">const</span>& c);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">template</span><length_t D, <span class="keyword">typename</span> T, qualifier Q, <span class="keyword">typename</span> I></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="a00958.html#ga2c7b5ff4e0f4132a23e58eeb0803b53a"> 71</a></span>  GLM_FUNC_DECL mat<D, D, T, Q> <a class="code" href="a00958.html#ga666383aa52036f00f3b66e4e7e56da3a">computeCovarianceMatrix</a>(I <span class="keyword">const</span>& b, I <span class="keyword">const</span>& <a class="code" href="a00899.html#ga4b7956eb6e2fbedfc7cf2e46e85c5139">e</a>);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">template</span><length_t D, <span class="keyword">typename</span> T, qualifier Q, <span class="keyword">typename</span> I></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="a00958.html#ga666383aa52036f00f3b66e4e7e56da3a"> 76</a></span>  GLM_FUNC_DECL mat<D, D, T, Q> <a class="code" href="a00958.html#ga666383aa52036f00f3b66e4e7e56da3a">computeCovarianceMatrix</a>(I <span class="keyword">const</span>& b, I <span class="keyword">const</span>& <a class="code" href="a00899.html#ga4b7956eb6e2fbedfc7cf2e46e85c5139">e</a>, vec<D, T, Q> <span class="keyword">const</span>& c);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">template</span><length_t D, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="a00958.html#ga0586007af1073c8b0f629bca0ee7c46c"> 87</a></span>  GLM_FUNC_DECL <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a00958.html#ga0586007af1073c8b0f629bca0ee7c46c">findEigenvaluesSymReal</a></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  (</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  mat<D, D, T, Q> <span class="keyword">const</span>& covarMat,</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  vec<D, T, Q>& outEigenvalues,</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  mat<D, D, T, Q>& outEigenvectors</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  );</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="a00958.html#ga86e8b8630d5731bb385a979038c62258"> 97</a></span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00958.html#gaf23e35406e7e192520bd670b20235d5b">sortEigenvalues</a>(vec<2, T, Q>& eigenvalues, mat<2, 2, T, Q>& eigenvectors);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="a00958.html#gaafa0226e6e0d0d8c5cb47bc9466f8eac"> 102</a></span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00958.html#gaf23e35406e7e192520bd670b20235d5b">sortEigenvalues</a>(vec<3, T, Q>& eigenvalues, mat<3, 3, T, Q>& eigenvectors);</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="a00958.html#gaf23e35406e7e192520bd670b20235d5b"> 107</a></span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00958.html#gaf23e35406e7e192520bd670b20235d5b">sortEigenvalues</a>(vec<4, T, Q>& eigenvalues, mat<4, 4, T, Q>& eigenvectors);</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> }<span class="comment">//namespace glm</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#include "pca.inl"</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aa00958_html_ga666383aa52036f00f3b66e4e7e56da3a"><div class="ttname"><a href="a00958.html#ga666383aa52036f00f3b66e4e7e56da3a">glm::computeCovarianceMatrix</a></div><div class="ttdeci">GLM_FUNC_DECL mat< D, D, T, Q > computeCovarianceMatrix(I const &b, I const &e, vec< D, T, Q > const &c)</div><div class="ttdoc">Compute a covariance matrix form a pair of iterators b (begin) and e (end) of a container with absolu...</div></div>
|
|
<div class="ttc" id="aa00958_html_gaf23e35406e7e192520bd670b20235d5b"><div class="ttname"><a href="a00958.html#gaf23e35406e7e192520bd670b20235d5b">glm::sortEigenvalues</a></div><div class="ttdeci">GLM_FUNC_DECL void sortEigenvalues(vec< 4, T, Q > &eigenvalues, mat< 4, 4, T, Q > &eigenvectors)</div><div class="ttdoc">Sorts a group of Eigenvalues&Eigenvectors, for largest Eigenvalue to smallest Eigenvalue.</div></div>
|
|
<div class="ttc" id="aa00899_html_ga4b7956eb6e2fbedfc7cf2e46e85c5139"><div class="ttname"><a href="a00899.html#ga4b7956eb6e2fbedfc7cf2e46e85c5139">glm::e</a></div><div class="ttdeci">GLM_FUNC_DECL GLM_CONSTEXPR genType e()</div><div class="ttdoc">Return e constant.</div></div>
|
|
<div class="ttc" id="aa00958_html_ga0586007af1073c8b0f629bca0ee7c46c"><div class="ttname"><a href="a00958.html#ga0586007af1073c8b0f629bca0ee7c46c">glm::findEigenvaluesSymReal</a></div><div class="ttdeci">GLM_FUNC_DECL unsigned int findEigenvaluesSymReal(mat< D, D, T, Q > const &covarMat, vec< D, T, Q > &outEigenvalues, mat< D, D, T, Q > &outEigenvectors)</div><div class="ttdoc">Assuming the provided covariance matrix covarMat is symmetric and real-valued, this function find the...</div></div>
|
|
<!-- 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.18
|
|
</small></address>
|
|
</body>
|
|
</html>
|