diff options
Diffstat (limited to 'namespaceyage_1_1math_1_1matrix.html')
| -rw-r--r-- | namespaceyage_1_1math_1_1matrix.html | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/namespaceyage_1_1math_1_1matrix.html b/namespaceyage_1_1math_1_1matrix.html new file mode 100644 index 00000000..e1f1aebd --- /dev/null +++ b/namespaceyage_1_1math_1_1matrix.html @@ -0,0 +1,225 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>YAGE: yage::math::matrix Namespace Reference</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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">YAGE +  <span id="projectnumber">v0.1.1</span> + </div> + <div id="projectbrief">Yet Another Game Engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('namespaceyage_1_1math_1_1matrix.html','');}); +</script> +<div id="doc-content"> +<!-- 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">yage::math::matrix Namespace Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Namespace containing functions that operate on matrices. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a1817702d14452819e9d32d03bca6f964"><td class="memTemplParams" colspan="2">template<int M, int N, class T > </td></tr> +<tr class="memitem:a1817702d14452819e9d32d03bca6f964"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< N, M, T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1math_1_1matrix.html#a1817702d14452819e9d32d03bca6f964">transpose</a> (const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< M, N, T > &m)</td></tr> +<tr class="memdesc:a1817702d14452819e9d32d03bca6f964"><td class="mdescLeft"> </td><td class="mdescRight">Transposes a matrix and returns the result. <a href="#a1817702d14452819e9d32d03bca6f964">More...</a><br /></td></tr> +<tr class="separator:a1817702d14452819e9d32d03bca6f964"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af4365b8599f08ad8940e4b0bb79373b8"><td class="memTemplParams" colspan="2">template<int R, class T > </td></tr> +<tr class="memitem:af4365b8599f08ad8940e4b0bb79373b8"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1math_1_1matrix.html#af4365b8599f08ad8940e4b0bb79373b8">dot</a> (const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< R, 1, T > &m1, const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< R, 1, T > &m2)</td></tr> +<tr class="memdesc:af4365b8599f08ad8940e4b0bb79373b8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dot product between two vectors. <a href="#af4365b8599f08ad8940e4b0bb79373b8">More...</a><br /></td></tr> +<tr class="separator:af4365b8599f08ad8940e4b0bb79373b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2b95572fa9d23e59fd0969e70b581eec"><td class="memTemplParams" colspan="2">template<int M, int N, int P, int Q, class T > </td></tr> +<tr class="memitem:a2b95572fa9d23e59fd0969e70b581eec"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< M, Q, T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1math_1_1matrix.html#a2b95572fa9d23e59fd0969e70b581eec">multiply</a> (const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< M, N, T > &m1, const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< P, Q, T > &m2)</td></tr> +<tr class="memdesc:a2b95572fa9d23e59fd0969e70b581eec"><td class="mdescLeft"> </td><td class="mdescRight">Multiplies two matrices together. <a href="#a2b95572fa9d23e59fd0969e70b581eec">More...</a><br /></td></tr> +<tr class="separator:a2b95572fa9d23e59fd0969e70b581eec"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Implementations defined here are meant to operate on anything that inherits from the base <a class="el" href="classyage_1_1math_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="af4365b8599f08ad8940e4b0bb79373b8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af4365b8599f08ad8940e4b0bb79373b8">◆ </a></span>dot()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<int R, class T > </div> + <table class="memname"> + <tr> + <td class="memname">T yage::math::matrix::dot </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< R, 1, T > & </td> + <td class="paramname"><em>m1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< R, 1, T > & </td> + <td class="paramname"><em>m2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">m1,m2</td><td>Input matrices. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a2b95572fa9d23e59fd0969e70b581eec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2b95572fa9d23e59fd0969e70b581eec">◆ </a></span>multiply()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<int M, int N, int P, int Q, class T > </div> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a><M, Q, T> yage::math::matrix::multiply </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< M, N, T > & </td> + <td class="paramname"><em>m1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< P, Q, T > & </td> + <td class="paramname"><em>m2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">m1,m2</td><td><a class="el" href="classyage_1_1math_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> inputs</td></tr> + </table> + </dd> +</dl> +<p>Requires the two matrices to be compatible with multiplication. </p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>Think if this should be a static_assert. </dd></dl> +<p>Performs multiplication by getting the rows and columns, transposing one of them and then doting the result. </p> + +</div> +</div> +<a id="a1817702d14452819e9d32d03bca6f964"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1817702d14452819e9d32d03bca6f964">◆ </a></span>transpose()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<int M, int N, class T > </div> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a><N, M, T> yage::math::matrix::transpose </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classyage_1_1math_1_1Matrix.html">Matrix</a>< M, N, T > & </td> + <td class="paramname"><em>m</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">m</td><td>input matrix. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespaceyage.html">yage</a></li><li class="navelem"><a class="el" href="namespaceyage_1_1math.html">math</a></li><li class="navelem"><a class="el" href="namespaceyage_1_1math_1_1matrix.html">matrix</a></li> + <li class="footer">Generated on Fri Aug 25 2017 14:05:22 for YAGE by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |