a00209.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.9 API documenation: GLM_GTX_matrix_factorisation</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">0.9.9 API documenation
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. </div><!-- top -->
  62. <!-- window showing the filter options -->
  63. <div id="MSearchSelectWindow"
  64. onmouseover="return searchBox.OnSearchSelectShow()"
  65. onmouseout="return searchBox.OnSearchSelectHide()"
  66. onkeydown="return searchBox.OnSearchSelectKey(event)">
  67. </div>
  68. <!-- iframe showing the search results (closed by default) -->
  69. <div id="MSearchResultsWindow">
  70. <iframe src="javascript:void(0)" frameborder="0"
  71. name="MSearchResults" id="MSearchResults">
  72. </iframe>
  73. </div>
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#func-members">Functions</a> </div>
  77. <div class="headertitle">
  78. <div class="title">GLM_GTX_matrix_factorisation<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p>Functions to factor matrices in various forms.
  82. <a href="#details">More...</a></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85. Functions</h2></td></tr>
  86. <tr class="memitem:ga834fe9f3b29ac4f6636e102dcf6c45be"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier P, template&lt; length_t, length_t, typename, qualifier &gt; class matType&gt; </td></tr>
  87. <tr class="memitem:ga834fe9f3b29ac4f6636e102dcf6c45be"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; C, R, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga834fe9f3b29ac4f6636e102dcf6c45be">fliplr</a> (matType&lt; C, R, T, P &gt; const &amp;in)</td></tr>
  88. <tr class="memdesc:ga834fe9f3b29ac4f6636e102dcf6c45be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flips the matrix columns right and left. <a href="a00209.html#ga834fe9f3b29ac4f6636e102dcf6c45be">More...</a><br /></td></tr>
  89. <tr class="separator:ga834fe9f3b29ac4f6636e102dcf6c45be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga5c0b0b7dde6aef33a8c73376fe00ddc6"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier P, template&lt; length_t, length_t, typename, qualifier &gt; class matType&gt; </td></tr>
  91. <tr class="memitem:ga5c0b0b7dde6aef33a8c73376fe00ddc6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; C, R, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga5c0b0b7dde6aef33a8c73376fe00ddc6">flipud</a> (matType&lt; C, R, T, P &gt; const &amp;in)</td></tr>
  92. <tr class="memdesc:ga5c0b0b7dde6aef33a8c73376fe00ddc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flips the matrix rows up and down. <a href="a00209.html#ga5c0b0b7dde6aef33a8c73376fe00ddc6">More...</a><br /></td></tr>
  93. <tr class="separator:ga5c0b0b7dde6aef33a8c73376fe00ddc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ga3f35a503ef41c16f83cf6cd8a191aca6"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier P, template&lt; length_t, length_t, typename, qualifier &gt; class matType&gt; </td></tr>
  95. <tr class="memitem:ga3f35a503ef41c16f83cf6cd8a191aca6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga3f35a503ef41c16f83cf6cd8a191aca6">qr_decompose</a> (matType&lt; C, R, T, P &gt; const &amp;in, matType&lt;(C&lt; R?C:R), R, T, P &gt; &amp;q, matType&lt; C,(C&lt; R?C:R), T, P &gt; &amp;r)</td></tr>
  96. <tr class="memdesc:ga3f35a503ef41c16f83cf6cd8a191aca6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs QR factorisation of a matrix. <a href="a00209.html#ga3f35a503ef41c16f83cf6cd8a191aca6">More...</a><br /></td></tr>
  97. <tr class="separator:ga3f35a503ef41c16f83cf6cd8a191aca6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:gac81cf0350006c3f004887fa4fb57880e"><td class="memTemplParams" colspan="2">template&lt;length_t C, length_t R, typename T , qualifier P, template&lt; length_t, length_t, typename, qualifier &gt; class matType&gt; </td></tr>
  99. <tr class="memitem:gac81cf0350006c3f004887fa4fb57880e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#gac81cf0350006c3f004887fa4fb57880e">rq_decompose</a> (matType&lt; C, R, T, P &gt; const &amp;in, matType&lt;(C&lt; R?C:R), R, T, P &gt; &amp;r, matType&lt; C,(C&lt; R?C:R), T, P &gt; &amp;q)</td></tr>
  100. <tr class="memdesc:gac81cf0350006c3f004887fa4fb57880e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs RQ factorisation of a matrix. <a href="a00209.html#gac81cf0350006c3f004887fa4fb57880e">More...</a><br /></td></tr>
  101. <tr class="separator:gac81cf0350006c3f004887fa4fb57880e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  104. <p>Functions to factor matrices in various forms. </p>
  105. <p>&lt;<a class="el" href="a00067.html" title="GLM_GTX_matrix_factorisation ">glm/gtx/matrix_factorisation.hpp</a>&gt; need to be included to use these functionalities. </p>
  106. <h2 class="groupheader">Function Documentation</h2>
  107. <a class="anchor" id="ga834fe9f3b29ac4f6636e102dcf6c45be"></a>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">GLM_FUNC_DECL matType&lt;C, R, T, P&gt; glm::fliplr </td>
  113. <td>(</td>
  114. <td class="paramtype">matType&lt; C, R, T, P &gt; const &amp;&#160;</td>
  115. <td class="paramname"><em>in</em></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </div><div class="memdoc">
  120. <p>Flips the matrix columns right and left. </p>
  121. <p>From GLM_GTX_matrix_factorisation extension. </p>
  122. </div>
  123. </div>
  124. <a class="anchor" id="ga5c0b0b7dde6aef33a8c73376fe00ddc6"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">GLM_FUNC_DECL matType&lt;C, R, T, P&gt; glm::flipud </td>
  130. <td>(</td>
  131. <td class="paramtype">matType&lt; C, R, T, P &gt; const &amp;&#160;</td>
  132. <td class="paramname"><em>in</em></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Flips the matrix rows up and down. </p>
  138. <p>From GLM_GTX_matrix_factorisation extension. </p>
  139. </div>
  140. </div>
  141. <a class="anchor" id="ga3f35a503ef41c16f83cf6cd8a191aca6"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">GLM_FUNC_DECL void glm::qr_decompose </td>
  147. <td>(</td>
  148. <td class="paramtype">matType&lt; C, R, T, P &gt; const &amp;&#160;</td>
  149. <td class="paramname"><em>in</em></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>Performs QR factorisation of a matrix. </p>
  155. <p>Returns 2 matrices, q and r, such that the columns of q are orthonormal and span the same subspace than those of the input matrix, r is an upper triangular matrix, and q*r=in. Given an n-by-m input matrix, q has dimensions min(n,m)-by-m, and r has dimensions n-by-min(n,m). From GLM_GTX_matrix_factorisation extension. </p>
  156. </div>
  157. </div>
  158. <a class="anchor" id="gac81cf0350006c3f004887fa4fb57880e"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">GLM_FUNC_DECL void glm::rq_decompose </td>
  164. <td>(</td>
  165. <td class="paramtype">matType&lt; C, R, T, P &gt; const &amp;&#160;</td>
  166. <td class="paramname"><em>in</em></td><td>)</td>
  167. <td></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Performs RQ factorisation of a matrix. </p>
  172. <p>Returns 2 matrices, r and q, such that r is an upper triangular matrix, the rows of q are orthonormal and span the same subspace than those of the input matrix, and r*q=in. Note that in the context of RQ factorisation, the diagonal is seen as starting in the lower-right corner of the matrix, instead of the usual upper-left. Given an n-by-m input matrix, r has dimensions min(n,m)-by-m, and q has dimensions n-by-min(n,m). From GLM_GTX_matrix_factorisation extension. </p>
  173. </div>
  174. </div>
  175. </div><!-- contents -->
  176. <!-- start footer part -->
  177. <hr class="footer"/><address class="footer"><small>
  178. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  179. <img class="footer" src="doxygen.png" alt="doxygen"/>
  180. </a> 1.8.10
  181. </small></address>
  182. </body>
  183. </html>