diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2017-09-02 12:28:11 +0100 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2017-09-02 12:28:11 +0100 |
commit | 8ad8165816929301a87e90bbb32c3df6b69030ee (patch) | |
tree | 34038f021264d1f39055b85833be7169728f6540 /namespaceyage_1_1matrix.html | |
parent | d7364eb89f81fa770bc3658a93917412baa020df (diff) | |
download | YAGE-8ad8165816929301a87e90bbb32c3df6b69030ee.tar.gz YAGE-8ad8165816929301a87e90bbb32c3df6b69030ee.zip |
Updating docs
Diffstat (limited to 'namespaceyage_1_1matrix.html')
-rw-r--r-- | namespaceyage_1_1matrix.html | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/namespaceyage_1_1matrix.html b/namespaceyage_1_1matrix.html index 06ffedad..2e84412e 100644 --- a/namespaceyage_1_1matrix.html +++ b/namespaceyage_1_1matrix.html @@ -29,7 +29,7 @@ <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">YAGE -  <span id="projectnumber">0.02</span> +  <span id="projectnumber">v0.1.1</span> </div> <div id="projectbrief">Yet Another Game Engine</div> </td> @@ -107,7 +107,8 @@ Functions</h2></td></tr> <tr class="separator:a277125ad9fa06a7119c59d350e129985"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"></div><h2 class="groupheader">Function Documentation</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_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class. </p> +</div><h2 class="groupheader">Function Documentation</h2> <a id="ac4d2f55a5c3369ec42001776a582c30a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac4d2f55a5c3369ec42001776a582c30a">◆ </a></span>dot()</h2> @@ -137,7 +138,7 @@ template<int R, class T > </div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">m1,m2</td><td>Input matrices. </td></tr> + <tr><td class="paramname">m1,m2</td><td>Input matrices. </td></tr> </table> </dd> </dl> @@ -173,11 +174,13 @@ template<int M, int N, int P, int Q, class T > </div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><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> + <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#_todo000001">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> @@ -200,7 +203,7 @@ template<int M, int N, class T > </div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>input matrix. </td></tr> + <tr><td class="paramname">m</td><td>input matrix. </td></tr> </table> </dd> </dl> @@ -213,7 +216,7 @@ template<int M, int N, class T > </div> <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_1matrix.html">matrix</a></li> - <li class="footer">Generated on Thu Aug 24 2017 00:24:55 for YAGE by + <li class="footer">Generated on Sat Sep 2 2017 12:28:04 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> |