mirror of
https://github.com/g-truc/glm.git
synced 2024-09-21 00:42:18 +00:00
142 lines
13 KiB
HTML
142 lines
13 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.10"/>
|
||
|
|
<title>0.9.9 API documenation: matrix_factorisation.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" />
|
||
|
|
</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">0.9.9 API documenation
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
||
|
|
<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="modules.html"><span>Modules</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>
|
||
|
|
</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_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_e8f3c1046ba4b357711397765359cd18.html">gtx</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">matrix_factorisation.hpp</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="a00067.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="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#pragma once</span></div>
|
||
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// Dependency:</span></div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "../glm.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"># error "GLM: GLM_GTX_matrix_factorisation 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="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#endif</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_matrix_factorisation extension included")</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</span></div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/*</span></div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">Suggestions:</span></div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> - Move helper functions flipud and fliplr to another file: They may be helpful in more general circumstances.</span></div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> - Implement other types of matrix factorisation, such as: QL and LQ, L(D)U, eigendecompositions, etc...</span></div>
|
||
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*/</span></div>
|
||
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span><a class="code" href="a00143.html">glm</a></div>
|
||
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
|
||
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
|
||
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier P, <span class="keyword">template</span><length_t, length_t, <span class="keyword">typename</span>, qualifier> <span class="keyword">class </span>matType></div>
|
||
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  GLM_FUNC_DECL matType<C, R, T, P> <a class="code" href="a00209.html#ga5c0b0b7dde6aef33a8c73376fe00ddc6">flipud</a>(matType<C, R, T, P> <span class="keyword">const</span>& in);</div>
|
||
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier P, <span class="keyword">template</span><length_t, length_t, <span class="keyword">typename</span>, qualifier> <span class="keyword">class </span>matType></div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  GLM_FUNC_DECL matType<C, R, T, P> <a class="code" href="a00209.html#ga834fe9f3b29ac4f6636e102dcf6c45be">fliplr</a>(matType<C, R, T, P> <span class="keyword">const</span>& in);</div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
|
||
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier P, <span class="keyword">template</span><length_t, length_t, <span class="keyword">typename</span>, qualifier> <span class="keyword">class </span>matType></div>
|
||
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00209.html#ga3f35a503ef41c16f83cf6cd8a191aca6">qr_decompose</a>(matType<C, R, T, P> <span class="keyword">const</span>& in, matType<(C < R ? C : R), R, T, P>& q, matType<C, (C < R ? C : R), T, P>& r);</div>
|
||
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
||
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier P, <span class="keyword">template</span><length_t, length_t, <span class="keyword">typename</span>, qualifier> <span class="keyword">class </span>matType></div>
|
||
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00209.html#gac81cf0350006c3f004887fa4fb57880e">rq_decompose</a>(matType<C, R, T, P> <span class="keyword">const</span>& in, matType<(C < R ? C : R), R, T, P>& r, matType<C, (C < R ? C : R), T, P>& q);</div>
|
||
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
||
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> }</div>
|
||
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#include "matrix_factorisation.inl"</span></div>
|
||
|
|
<div class="ttc" id="a00209_html_ga3f35a503ef41c16f83cf6cd8a191aca6"><div class="ttname"><a href="a00209.html#ga3f35a503ef41c16f83cf6cd8a191aca6">glm::qr_decompose</a></div><div class="ttdeci">GLM_FUNC_DECL void qr_decompose(matType< C, R, T, P > const &in, matType<(C< R?C:R), R, T, P > &q, matType< C,(C< R?C:R), T, P > &r)</div><div class="ttdoc">Performs QR factorisation of a matrix. </div></div>
|
||
|
|
<div class="ttc" id="a00209_html_gac81cf0350006c3f004887fa4fb57880e"><div class="ttname"><a href="a00209.html#gac81cf0350006c3f004887fa4fb57880e">glm::rq_decompose</a></div><div class="ttdeci">GLM_FUNC_DECL void rq_decompose(matType< C, R, T, P > const &in, matType<(C< R?C:R), R, T, P > &r, matType< C,(C< R?C:R), T, P > &q)</div><div class="ttdoc">Performs RQ factorisation of a matrix. </div></div>
|
||
|
|
<div class="ttc" id="a00209_html_ga834fe9f3b29ac4f6636e102dcf6c45be"><div class="ttname"><a href="a00209.html#ga834fe9f3b29ac4f6636e102dcf6c45be">glm::fliplr</a></div><div class="ttdeci">GLM_FUNC_DECL matType< C, R, T, P > fliplr(matType< C, R, T, P > const &in)</div><div class="ttdoc">Flips the matrix columns right and left. </div></div>
|
||
|
|
<div class="ttc" id="a00143_html"><div class="ttname"><a href="a00143.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
|
||
|
|
<div class="ttc" id="a00209_html_ga5c0b0b7dde6aef33a8c73376fe00ddc6"><div class="ttname"><a href="a00209.html#ga5c0b0b7dde6aef33a8c73376fe00ddc6">glm::flipud</a></div><div class="ttdeci">GLM_FUNC_DECL matType< C, R, T, P > flipud(matType< C, R, T, P > const &in)</div><div class="ttdoc">Flips the matrix rows up and down. </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.10
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|