aboutsummaryrefslogtreecommitdiffstats
path: root/namespaceyage_1_1matrix.html
blob: 29d99acf5d1fa3fe6266de60396a5375625ec80c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<!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.6"/>
<title>yage::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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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="yage.png"/></td>
    <td style="padding-left: 0.5em;">
    <div id="projectbrief">Yet Another Game Engine</div>
    </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
      <li><a href="namespacemembers.html"><span>Namespace&#160;Members</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></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="namespaceyage.html">yage</a></li><li class="navelem"><a class="el" href="namespaceyage_1_1matrix.html">matrix</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">yage::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:a62de4b4b6bab23717d957c370f2e41c7"><td class="memTemplParams" colspan="2">template&lt;int M, int N, class T &gt; </td></tr>
<tr class="memitem:a62de4b4b6bab23717d957c370f2e41c7"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; N, M, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1matrix.html#a62de4b4b6bab23717d957c370f2e41c7">transpose</a> (const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; M, N, T &gt; &amp;m)</td></tr>
<tr class="memdesc:a62de4b4b6bab23717d957c370f2e41c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transposes a matrix and returns the result.  <a href="#a62de4b4b6bab23717d957c370f2e41c7">More...</a><br/></td></tr>
<tr class="separator:a62de4b4b6bab23717d957c370f2e41c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d2f55a5c3369ec42001776a582c30a"><td class="memTemplParams" colspan="2">template&lt;int R, class T &gt; </td></tr>
<tr class="memitem:ac4d2f55a5c3369ec42001776a582c30a"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1matrix.html#ac4d2f55a5c3369ec42001776a582c30a">dot</a> (const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; R, 1, T &gt; &amp;m1, const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; R, 1, T &gt; &amp;m2)</td></tr>
<tr class="memdesc:ac4d2f55a5c3369ec42001776a582c30a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the dot product between two vectors.  <a href="#ac4d2f55a5c3369ec42001776a582c30a">More...</a><br/></td></tr>
<tr class="separator:ac4d2f55a5c3369ec42001776a582c30a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a277125ad9fa06a7119c59d350e129985"><td class="memTemplParams" colspan="2">template&lt;int M, int N, int P, int Q, class T &gt; </td></tr>
<tr class="memitem:a277125ad9fa06a7119c59d350e129985"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; M, Q, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1matrix.html#a277125ad9fa06a7119c59d350e129985">multiply</a> (const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; M, N, T &gt; &amp;m1, const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt; P, Q, T &gt; &amp;m2)</td></tr>
<tr class="memdesc:a277125ad9fa06a7119c59d350e129985"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplies two matrices together.  <a href="#a277125ad9fa06a7119c59d350e129985">More...</a><br/></td></tr>
<tr class="separator:a277125ad9fa06a7119c59d350e129985"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Namespace containing functions that operate on matrices. </p>
<p>Implementations defined here are meant to operate on anything that inherits from the base <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac4d2f55a5c3369ec42001776a582c30a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int R, class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T yage::matrix::dot </td>
          <td>(</td>
          <td class="paramtype">const Matrix&lt; R, 1, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>m1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Matrix&lt; R, 1, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>m2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the dot product between two vectors. </p>
<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 class="anchor" id="a277125ad9fa06a7119c59d350e129985"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int M, int N, int P, int Q, class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt;M, Q, T&gt; yage::matrix::multiply </td>
          <td>(</td>
          <td class="paramtype">const Matrix&lt; M, N, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>m1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Matrix&lt; P, Q, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>m2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Multiplies two matrices together. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">m1,m2</td><td><a class="el" href="classyage_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 class="anchor" id="a62de4b4b6bab23717d957c370f2e41c7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int M, int N, class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classyage_1_1Matrix.html">Matrix</a>&lt;N, M, T&gt; yage::matrix::transpose </td>
          <td>(</td>
          <td class="paramtype">const Matrix&lt; M, N, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>m</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Transposes a matrix and returns the result. </p>
<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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 23 2018 15:09:53 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>