diff options
Diffstat (limited to 'namespaceyage_1_1matrix.html')
-rw-r--r-- | namespaceyage_1_1matrix.html | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/namespaceyage_1_1matrix.html b/namespaceyage_1_1matrix.html index d1adc39f..d3711d5e 100644 --- a/namespaceyage_1_1matrix.html +++ b/namespaceyage_1_1matrix.html @@ -130,7 +130,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"><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 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"> @@ -157,6 +158,8 @@ template<int R, class T > </div> </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> @@ -191,6 +194,8 @@ template<int M, int N, int P, int Q, class T > </div> </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> @@ -198,7 +203,7 @@ template<int M, int N, int P, int Q, class T > </div> </dd> </dl> <p>Requires the two matrices to be compatible with multiplication. </p> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>Think if this should be a static_assert. </dd></dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">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> @@ -218,6 +223,8 @@ template<int M, int N, class T > </div> </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> @@ -233,7 +240,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 Sat Dec 23 2017 01:50:21 for YAGE by + <li class="footer">Generated on Sat Jan 6 2018 11:36:17 for YAGE by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> </ul> |