mirror of
https://github.com/g-truc/glm.git
synced 2024-11-10 04:31:47 +00:00
143 lines
12 KiB
HTML
143 lines
12 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 documentation: 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="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">0.9.9 API documentation
|
||
|
|
</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_3a581ba30d25676e4b797b1f96d53b45.html">F:</a></li><li class="navelem"><a class="el" href="dir_9e5fe034a00e89334fd5186c3e7db156.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_d9496f0844b48bc7e53b5af8c99b9ab2.html">Source</a></li><li class="navelem"><a class="el" href="dir_a8bee7be44182a33f3820393ae0b105d.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_44e5e654415abd9ca6fdeaddaff8565e.html">glm</a></li><li class="navelem"><a class="el" href="dir_cef2d71d502cb69a9252bca2297d9549.html">glm</a></li><li class="navelem"><a class="el" href="dir_f35778ec600a1b9bbc4524e62e226aa2.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="a00081.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">#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"># ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"># pragma message("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="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"># else</span></div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_matrix_factorisation extension included")</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"># endif</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="a00236.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="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  GLM_FUNC_DECL mat<C, R, T, Q> <a class="code" href="a00336.html#ga85003371f0ba97380dd25e8905de1870">flipud</a>(mat<C, R, T, Q> <span class="keyword">const</span>& in);</div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  GLM_FUNC_DECL mat<C, R, T, Q> <a class="code" href="a00336.html#gaf39f4e5f78eb29c1a90277d45b9b3feb">fliplr</a>(mat<C, R, T, Q> <span class="keyword">const</span>& in);</div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00336.html#gac62d7bfc8dc661e616620d70552cd566">qr_decompose</a>(mat<C, R, T, Q> <span class="keyword">const</span>& in, mat<(C < R ? C : R), R, T, Q>& q, mat<C, (C < R ? C : R), T, Q>& r);</div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
|
||
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">template</span> <length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00336.html#ga82874e2ebe891ba35ac21d9993873758">rq_decompose</a>(mat<C, R, T, Q> <span class="keyword">const</span>& in, mat<(C < R ? C : R), R, T, Q>& r, mat<C, (C < R ? C : R), T, Q>& q);</div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> }</div>
|
||
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
||
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#include "matrix_factorisation.inl"</span></div>
|
||
|
|
<div class="ttc" id="a00336_html_ga82874e2ebe891ba35ac21d9993873758"><div class="ttname"><a href="a00336.html#ga82874e2ebe891ba35ac21d9993873758">glm::rq_decompose</a></div><div class="ttdeci">GLM_FUNC_DECL void rq_decompose(mat< C, R, T, Q > const &in, mat<(C< R?C:R), R, T, Q > &r, mat< C,(C< R?C:R), T, Q > &q)</div><div class="ttdoc">Performs RQ factorisation of a matrix. </div></div>
|
||
|
|
<div class="ttc" id="a00336_html_gac62d7bfc8dc661e616620d70552cd566"><div class="ttname"><a href="a00336.html#gac62d7bfc8dc661e616620d70552cd566">glm::qr_decompose</a></div><div class="ttdeci">GLM_FUNC_DECL void qr_decompose(mat< C, R, T, Q > const &in, mat<(C< R?C:R), R, T, Q > &q, mat< C,(C< R?C:R), T, Q > &r)</div><div class="ttdoc">Performs QR factorisation of a matrix. </div></div>
|
||
|
|
<div class="ttc" id="a00336_html_ga85003371f0ba97380dd25e8905de1870"><div class="ttname"><a href="a00336.html#ga85003371f0ba97380dd25e8905de1870">glm::flipud</a></div><div class="ttdeci">GLM_FUNC_DECL mat< C, R, T, Q > flipud(mat< C, R, T, Q > const &in)</div><div class="ttdoc">Flips the matrix rows up and down. </div></div>
|
||
|
|
<div class="ttc" id="a00336_html_gaf39f4e5f78eb29c1a90277d45b9b3feb"><div class="ttname"><a href="a00336.html#gaf39f4e5f78eb29c1a90277d45b9b3feb">glm::fliplr</a></div><div class="ttdeci">GLM_FUNC_DECL mat< C, R, T, Q > fliplr(mat< C, R, T, Q > const &in)</div><div class="ttdoc">Flips the matrix columns right and left. </div></div>
|
||
|
|
<div class="ttc" id="a00236_html"><div class="ttname"><a href="a00236.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></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>
|