aboutsummaryrefslogtreecommitdiffstats
path: root/matrix_8hpp.html
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2017-07-29 10:00:20 +0100
committerYann Herklotz <ymherklotz@gmail.com>2017-07-29 10:00:20 +0100
commit3d96965ecd28b9037a83c4b22f65fcf502dce336 (patch)
tree46530a0a38fe558b324edeb8bc88ded9ac7bc881 /matrix_8hpp.html
parente7770985a2be00cc22c3cd1302afb1fcc16bf94b (diff)
downloadYAGE-3d96965ecd28b9037a83c4b22f65fcf502dce336.tar.gz
YAGE-3d96965ecd28b9037a83c4b22f65fcf502dce336.zip
Updating docs
Diffstat (limited to 'matrix_8hpp.html')
-rw-r--r--matrix_8hpp.html81
1 files changed, 18 insertions, 63 deletions
diff --git a/matrix_8hpp.html b/matrix_8hpp.html
index dd32e129..b4261d56 100644
--- a/matrix_8hpp.html
+++ b/matrix_8hpp.html
@@ -22,6 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">YAGE
+ &#160;<span id="projectnumber">0.02</span>
</div>
<div id="projectbrief">Yet Another Game Engine</div>
</td>
@@ -87,87 +88,41 @@ $(function() {
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html">yage::Matrix&lt; Rows, Cols, Type &gt;</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base matrix class. <a href="classyage_1_1Matrix.html#details">More...</a><br /></td></tr>
-<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1detail_1_1Row.html">yage::detail::Row&lt; Rows, Cols, Type &gt;</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class used by other similar classes. <a href="classyage_1_1Matrix.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html">yage::Matrix&lt; Rows, Cols, Type &gt;</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base matrix class. <a href="classyage_1_1Matrix.html#details">More...</a><br /></td></tr>
-<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Vector.html">yage::Vector&lt; Rows, Type &gt;</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class used by other similar classes. <a href="classyage_1_1Matrix.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Vector2.html">yage::Vector2&lt; Type &gt;</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">2D Vector class. <a href="classyage_1_1Vector2.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
-<tr class="memitem:namespacedetail"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedetail.html">detail</a></td></tr>
-<tr class="memdesc:namespacedetail"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detail namespace. <br /></td></tr>
+<tr class="memitem:namespaceyage_1_1matrix"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1matrix.html">yage::matrix</a></td></tr>
+<tr class="memdesc:namespaceyage_1_1matrix"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace containing functions that operate on matrices. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a6cdcf60e5d3972cac5e8a6be40403078"><td class="memItemLeft" align="right" valign="top"><a id="a6cdcf60e5d3972cac5e8a6be40403078"></a>
-typedef Vector2&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>yage::Vector2d</b></td></tr>
+typedef Vector2&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="matrix_8hpp.html#a6cdcf60e5d3972cac5e8a6be40403078">yage::Vector2d</a></td></tr>
+<tr class="memdesc:a6cdcf60e5d3972cac5e8a6be40403078"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definition of a 2D vector. <br /></td></tr>
<tr class="separator:a6cdcf60e5d3972cac5e8a6be40403078"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
-<tr class="memitem:a226cc29763f745fd175844f4263d5dae"><td class="memTemplParams" colspan="2"><a id="a226cc29763f745fd175844f4263d5dae"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a226cc29763f745fd175844f4263d5dae"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator+</b> (Matrix&lt; M, N, T &gt; lhs, const Matrix&lt; M, N, T &gt; &amp;rhs)</td></tr>
-<tr class="separator:a226cc29763f745fd175844f4263d5dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2187fb11298a029f2877702192717090"><td class="memTemplParams" colspan="2"><a id="a2187fb11298a029f2877702192717090"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a2187fb11298a029f2877702192717090"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator-</b> (Matrix&lt; M, N, T &gt; lhs, const Matrix&lt; M, N, T &gt; &amp;rhs)</td></tr>
-<tr class="separator:a2187fb11298a029f2877702192717090"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a6b77afaa1cd077df90b9daccbfc2cbae"><td class="memTemplParams" colspan="2"><a id="a6b77afaa1cd077df90b9daccbfc2cbae"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a6b77afaa1cd077df90b9daccbfc2cbae"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator+</b> (Matrix&lt; M, N, T &gt; lhs, const T &amp;rhs)</td></tr>
-<tr class="separator:a6b77afaa1cd077df90b9daccbfc2cbae"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a947133b8fc764d9fc5c5d8b08821cf32"><td class="memTemplParams" colspan="2"><a id="a947133b8fc764d9fc5c5d8b08821cf32"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a947133b8fc764d9fc5c5d8b08821cf32"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator+</b> (const T &amp;lhs, Matrix&lt; M, N, T &gt; rhs)</td></tr>
-<tr class="separator:a947133b8fc764d9fc5c5d8b08821cf32"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a8a9db24697f649f6d19f0347330d95fe"><td class="memTemplParams" colspan="2"><a id="a8a9db24697f649f6d19f0347330d95fe"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a8a9db24697f649f6d19f0347330d95fe"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator-</b> (Matrix&lt; M, N, T &gt; lhs, const T &amp;rhs)</td></tr>
-<tr class="separator:a8a9db24697f649f6d19f0347330d95fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad9344d41af72f29cd6f8cf1ef62ed3cc"><td class="memTemplParams" colspan="2"><a id="ad9344d41af72f29cd6f8cf1ef62ed3cc"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:ad9344d41af72f29cd6f8cf1ef62ed3cc"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator-</b> (const T &amp;lhs, Matrix&lt; M, N, T &gt; rhs)</td></tr>
-<tr class="separator:ad9344d41af72f29cd6f8cf1ef62ed3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad8903f6a93ac89f16846458540717507"><td class="memTemplParams" colspan="2"><a id="ad8903f6a93ac89f16846458540717507"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:ad8903f6a93ac89f16846458540717507"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator*</b> (Matrix&lt; M, N, T &gt; lhs, const T &amp;rhs)</td></tr>
-<tr class="separator:ad8903f6a93ac89f16846458540717507"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a090cbd6b767b583364e9cbe78d8a8d5a"><td class="memTemplParams" colspan="2"><a id="a090cbd6b767b583364e9cbe78d8a8d5a"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a090cbd6b767b583364e9cbe78d8a8d5a"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator*</b> (const T &amp;lhs, Matrix&lt; M, N, T &gt; rhs)</td></tr>
-<tr class="separator:a090cbd6b767b583364e9cbe78d8a8d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:acca4a23afb94173695bbc1e1f2cde2b3"><td class="memTemplParams" colspan="2"><a id="acca4a23afb94173695bbc1e1f2cde2b3"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:acca4a23afb94173695bbc1e1f2cde2b3"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; M, N, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator/</b> (Matrix&lt; M, N, T &gt; lhs, const T &amp;rhs)</td></tr>
-<tr class="separator:acca4a23afb94173695bbc1e1f2cde2b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5ddd829cb1c7c4c880d0fd53326858fe"><td class="memTemplParams" colspan="2"><a id="a5ddd829cb1c7c4c880d0fd53326858fe"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a5ddd829cb1c7c4c880d0fd53326858fe"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator==</b> (const Matrix&lt; M, N, T &gt; &amp;lhs, const Matrix&lt; M, N, T &gt; &amp;rhs)</td></tr>
-<tr class="separator:a5ddd829cb1c7c4c880d0fd53326858fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"><td class="memTemplParams" colspan="2"><a id="a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::operator&lt;&lt;</b> (std::ostream &amp;os, const Matrix&lt; M, N, T &gt; &amp;mat)</td></tr>
-<tr class="separator:a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a62de4b4b6bab23717d957c370f2e41c7"><td class="memTemplParams" colspan="2"><a id="a62de4b4b6bab23717d957c370f2e41c7"></a>
-template&lt;int M, int N, class T &gt; </td></tr>
-<tr class="memitem:a62de4b4b6bab23717d957c370f2e41c7"><td class="memTemplItemLeft" align="right" valign="top">Matrix&lt; N, M, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::matrix::transpose</b> (const Matrix&lt; M, N, T &gt; &amp;m)</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">Matrix&lt; N, M, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1matrix.html#a62de4b4b6bab23717d957c370f2e41c7">yage::matrix::transpose</a> (const Matrix&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="namespaceyage_1_1matrix.html#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"><a id="ac4d2f55a5c3369ec42001776a582c30a"></a>
-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"><b>yage::matrix::dot</b> (const Matrix&lt; R, 1, T &gt; &amp;m1, const Matrix&lt; R, 1, T &gt; &amp;m2)</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">yage::matrix::dot</a> (const Matrix&lt; R, 1, T &gt; &amp;m1, const Matrix&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="namespaceyage_1_1matrix.html#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"><a id="a277125ad9fa06a7119c59d350e129985"></a>
-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">Matrix&lt; M, Q, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>yage::matrix::multiply</b> (const Matrix&lt; M, N, T &gt; &amp;m1, const Matrix&lt; P, Q, T &gt; &amp;m2)</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">Matrix&lt; M, Q, T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage_1_1matrix.html#a277125ad9fa06a7119c59d350e129985">yage::matrix::multiply</a> (const Matrix&lt; M, N, T &gt; &amp;m1, const Matrix&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="namespaceyage_1_1matrix.html#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>
@@ -177,7 +132,7 @@ template&lt;int M, int N, int P, int Q, class T &gt; </td></tr>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
-Generated by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Sat Jul 29 2017 10:00:18 for YAGE by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>