mirror of
https://github.com/g-truc/glm.git
synced 2024-11-25 09:54:35 +00:00
222 lines
11 KiB
HTML
222 lines
11 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: GLM_GTX_matrix_factorisation</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>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_GTX_matrix_factorisation<div class="ingroups"><a class="el" href="a00896.html">Experimental extensions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaf39f4e5f78eb29c1a90277d45b9b3feb"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:gaf39f4e5f78eb29c1a90277d45b9b3feb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< C, R, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00945.html#gaf39f4e5f78eb29c1a90277d45b9b3feb">fliplr</a> (mat< C, R, T, Q > const &in)</td></tr>
|
|
<tr class="memdesc:gaf39f4e5f78eb29c1a90277d45b9b3feb"><td class="mdescLeft"> </td><td class="mdescRight">Flips the matrix columns right and left. <a href="a00945.html#gaf39f4e5f78eb29c1a90277d45b9b3feb">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf39f4e5f78eb29c1a90277d45b9b3feb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga85003371f0ba97380dd25e8905de1870"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga85003371f0ba97380dd25e8905de1870"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< C, R, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00945.html#ga85003371f0ba97380dd25e8905de1870">flipud</a> (mat< C, R, T, Q > const &in)</td></tr>
|
|
<tr class="memdesc:ga85003371f0ba97380dd25e8905de1870"><td class="mdescLeft"> </td><td class="mdescRight">Flips the matrix rows up and down. <a href="a00945.html#ga85003371f0ba97380dd25e8905de1870">More...</a><br /></td></tr>
|
|
<tr class="separator:ga85003371f0ba97380dd25e8905de1870"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga77022dca1aa38add548f9f56a9f8071a"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga77022dca1aa38add548f9f56a9f8071a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00945.html#ga77022dca1aa38add548f9f56a9f8071a">qr_decompose</a> (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)</td></tr>
|
|
<tr class="memdesc:ga77022dca1aa38add548f9f56a9f8071a"><td class="mdescLeft"> </td><td class="mdescRight">Performs QR factorisation of a matrix. <a href="a00945.html#ga77022dca1aa38add548f9f56a9f8071a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga77022dca1aa38add548f9f56a9f8071a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4e022709c9e7eaad9d7cc315d2cdb05c"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga4e022709c9e7eaad9d7cc315d2cdb05c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00945.html#ga4e022709c9e7eaad9d7cc315d2cdb05c">rq_decompose</a> (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)</td></tr>
|
|
<tr class="memdesc:ga4e022709c9e7eaad9d7cc315d2cdb05c"><td class="mdescLeft"> </td><td class="mdescRight">Performs RQ factorisation of a matrix. <a href="a00945.html#ga4e022709c9e7eaad9d7cc315d2cdb05c">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4e022709c9e7eaad9d7cc315d2cdb05c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Include <<a class="el" href="a00659.html" title="GLM_GTX_matrix_factorisation">glm/gtx/matrix_factorisation.hpp</a>> to use the features of this extension.</p>
|
|
<p>Functions to factor matrices in various forms </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gaf39f4e5f78eb29c1a90277d45b9b3feb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf39f4e5f78eb29c1a90277d45b9b3feb">◆ </a></span>fliplr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat<C, R, T, Q> glm::fliplr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>in</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Flips the matrix columns right and left. </p>
|
|
<p>From GLM_GTX_matrix_factorisation extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga85003371f0ba97380dd25e8905de1870"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga85003371f0ba97380dd25e8905de1870">◆ </a></span>flipud()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat<C, R, T, Q> glm::flipud </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>in</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Flips the matrix rows up and down. </p>
|
|
<p>From GLM_GTX_matrix_factorisation extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga77022dca1aa38add548f9f56a9f8071a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga77022dca1aa38add548f9f56a9f8071a">◆ </a></span>qr_decompose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL void glm::qr_decompose </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">mat<(C< R ? C :R), R, T, Q > & </td>
|
|
<td class="paramname"><em>q</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">mat< C,(C< R ? C :R), T, Q > & </td>
|
|
<td class="paramname"><em>r</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs QR factorisation of a matrix. </p>
|
|
<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).</p>
|
|
<p>From GLM_GTX_matrix_factorisation extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4e022709c9e7eaad9d7cc315d2cdb05c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4e022709c9e7eaad9d7cc315d2cdb05c">◆ </a></span>rq_decompose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL void glm::rq_decompose </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>in</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">mat<(C< R ? C :R), R, T, Q > & </td>
|
|
<td class="paramname"><em>r</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">mat< C,(C< R ? C :R), T, Q > & </td>
|
|
<td class="paramname"><em>q</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs RQ factorisation of a matrix. </p>
|
|
<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).</p>
|
|
<p>From GLM_GTX_matrix_factorisation extension. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</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.18
|
|
</small></address>
|
|
</body>
|
|
</html>
|