diff options
Diffstat (limited to 'classyage_1_1Matrix.html')
| -rw-r--r-- | classyage_1_1Matrix.html | 41 |
1 files changed, 28 insertions, 13 deletions
diff --git a/classyage_1_1Matrix.html b/classyage_1_1Matrix.html index 1ff33119..81c2b6b0 100644 --- a/classyage_1_1Matrix.html +++ b/classyage_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> @@ -94,7 +94,7 @@ $(document).ready(function(){initNavTree('classyage_1_1Matrix.html','');}); <p>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></p> -<p><code>#include <<a class="el" href="matrix_8hpp_source.html">matrix.hpp</a>></code></p> +<p><code>#include <<a class="el" href="matrix_8h_source.html">matrix.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> @@ -107,21 +107,22 @@ Public Member Functions</h2></td></tr> <tr class="memdesc:acaf0837fade0cb4179603b97ac224965"><td class="mdescLeft"> </td><td class="mdescRight">Returns the row size of the <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a>. <a href="#acaf0837fade0cb4179603b97ac224965">More...</a><br /></td></tr> <tr class="separator:acaf0837fade0cb4179603b97ac224965"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2753285bcc49a050a49976a6dbc8e89a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a2753285bcc49a050a49976a6dbc8e89a">colSize</a> () const</td></tr> -<tr class="memdesc:a2753285bcc49a050a49976a6dbc8e89a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the column size of the Matrixxs. <a href="#a2753285bcc49a050a49976a6dbc8e89a">More...</a><br /></td></tr> +<tr class="memdesc:a2753285bcc49a050a49976a6dbc8e89a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the column size of the <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a>. <a href="#a2753285bcc49a050a49976a6dbc8e89a">More...</a><br /></td></tr> <tr class="separator:a2753285bcc49a050a49976a6dbc8e89a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adffb22a99417271958621ff1f51b7f08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Matrix.html">Matrix</a>< 1, Cols, Type > </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#adffb22a99417271958621ff1f51b7f08">getRow</a> (int row) const</td></tr> <tr class="memdesc:adffb22a99417271958621ff1f51b7f08"><td class="mdescLeft"> </td><td class="mdescRight">Return the row specified row as a <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> with only one row. <a href="#adffb22a99417271958621ff1f51b7f08">More...</a><br /></td></tr> <tr class="separator:adffb22a99417271958621ff1f51b7f08"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2833adcae1e01f637eba251c5aee7888"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, 1, Type > </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a2833adcae1e01f637eba251c5aee7888">getCol</a> (int col) const</td></tr> +<tr class="memdesc:a2833adcae1e01f637eba251c5aee7888"><td class="mdescLeft"> </td><td class="mdescRight">Get a specific column in a column vector. <a href="#a2833adcae1e01f637eba251c5aee7888">More...</a><br /></td></tr> <tr class="separator:a2833adcae1e01f637eba251c5aee7888"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a83d77d3a40ced5e2b703a6d66b6e6055"><td class="memItemLeft" align="right" valign="top">std::vector< Type >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a83d77d3a40ced5e2b703a6d66b6e6055">begin</a> ()</td></tr> -<tr class="memdesc:a83d77d3a40ced5e2b703a6d66b6e6055"><td class="mdescLeft"> </td><td class="mdescRight">iterator support for begin <a href="#a83d77d3a40ced5e2b703a6d66b6e6055">More...</a><br /></td></tr> +<tr class="memdesc:a83d77d3a40ced5e2b703a6d66b6e6055"><td class="mdescLeft"> </td><td class="mdescRight">Iterator support for the start. <a href="#a83d77d3a40ced5e2b703a6d66b6e6055">More...</a><br /></td></tr> <tr class="separator:a83d77d3a40ced5e2b703a6d66b6e6055"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a20ea5fe16d27ef15f775b5497cadc851"><td class="memItemLeft" align="right" valign="top">std::vector< Type >::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a20ea5fe16d27ef15f775b5497cadc851">end</a> ()</td></tr> -<tr class="memdesc:a20ea5fe16d27ef15f775b5497cadc851"><td class="mdescLeft"> </td><td class="mdescRight">iterator support for end <a href="#a20ea5fe16d27ef15f775b5497cadc851">More...</a><br /></td></tr> +<tr class="memdesc:a20ea5fe16d27ef15f775b5497cadc851"><td class="mdescLeft"> </td><td class="mdescRight">Iterator support for the end. <a href="#a20ea5fe16d27ef15f775b5497cadc851">More...</a><br /></td></tr> <tr class="separator:a20ea5fe16d27ef15f775b5497cadc851"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaa7273d046ac077da76ffaec876041d7"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#aaa7273d046ac077da76ffaec876041d7">toString</a> () const</td></tr> -<tr class="memdesc:aaa7273d046ac077da76ffaec876041d7"><td class="mdescLeft"> </td><td class="mdescRight">prints out the matrix, but can also be implemented by other classes to print data differently <a href="#aaa7273d046ac077da76ffaec876041d7">More...</a><br /></td></tr> +<tr class="memdesc:aaa7273d046ac077da76ffaec876041d7"><td class="mdescLeft"> </td><td class="mdescRight">Prints out the matrix, but can also be implemented by other classes to print data differently. <a href="#aaa7273d046ac077da76ffaec876041d7">More...</a><br /></td></tr> <tr class="separator:aaa7273d046ac077da76ffaec876041d7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9dc57c60a19b805a41b8bfb951ce2fef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1detail_1_1Row.html">detail::Row</a>< Rows, Cols, Type > </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a9dc57c60a19b805a41b8bfb951ce2fef">operator[]</a> (int row)</td></tr> <tr class="separator:a9dc57c60a19b805a41b8bfb951ce2fef"><td class="memSeparator" colspan="2"> </td></tr> @@ -147,9 +148,13 @@ Friends</h2></td></tr> <div class="textblock"><h3>template<int Rows = 4, int Cols = 4, class Type = double><br /> class yage::Matrix< Rows, Cols, Type ></h3> -<h1><a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class </h1> -<p>This is the base matrix class that can be used by all the other matrix like data structures. </p> -</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<h1>Matrix Class </h1> +<p>The matrix class is a templated class which implements a mathematical Matrix.</p> +<h2>Usage Guide </h2> +<p>The class can be instantiated</p> +<h2>Example Code </h2> +<p>Creating a Matrix and performing operations on it.</p> +<div class="fragment"><div class="line"><span class="preprocessor">#include <YAGE/Math/matrix.hpp></span></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span>, <span class="keywordtype">char</span> **)</div><div class="line">{</div><div class="line"> <a class="code" href="classyage_1_1Matrix.html">yage::Matrix<2, 2, int></a> mat1 {{1, 2, 3, 4}};</div><div class="line"> <a class="code" href="classyage_1_1Matrix.html">yage::Matrix<2, 2, int></a> mat2 {{5, 6, 7, 8}};</div><div class="line"></div><div class="line"> <span class="keywordtype">int</span> <a class="code" href="namespaceyage_1_1matrix.html#ac4d2f55a5c3369ec42001776a582c30a">dot</a> = <a class="code" href="namespaceyage_1_1matrix.html#ac4d2f55a5c3369ec42001776a582c30a">yage::math::dot</a>(mat1, mat2);</div><div class="line"> <span class="keywordflow">return</span> 0;</div><div class="line">}</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a73b7d1f94f4f72a2294b71b3a35794ad"></a> <h2 class="memtitle"><span class="permalink"><a href="#a73b7d1f94f4f72a2294b71b3a35794ad">◆ </a></span>Matrix() <span class="overload">[1/2]</span></h2> @@ -230,6 +235,7 @@ template<int Rows = 4, int Cols = 4, class Type = double> </div> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Iterator pointing to the start of the data. </dd></dl> </div> </div> @@ -284,6 +290,7 @@ template<int Rows = 4, int Cols = 4, class Type = double> </div> </tr> </table> </div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Iterator pointing to the end of the data. </dd></dl> </div> </div> @@ -312,6 +319,13 @@ template<int Rows = 4, int Cols = 4, class Type = double> </div> </tr> </table> </div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">col</td><td>Column number to be returned. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Column <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> of the selected column. </dd></dl> </div> </div> @@ -342,11 +356,11 @@ template<int Rows = 4, int Cols = 4, class Type = double> </div> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">row</td><td>Row number to be returned</td></tr> + <tr><td class="paramname">row</td><td>Row number to be returned. </td></tr> </table> </dd> </dl> -<p>Returns the row that is specified by the row variables. </p> +<dl class="section return"><dt>Returns</dt><dd>The row that is specified by the row variables. </dd></dl> </div> </div> @@ -513,6 +527,7 @@ template<int Rows = 4, int Cols = 4, class Type = double> </div> </tr> </table> </div><div class="memdoc"> +<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>When printing certain matrices, it omits a row or column. Still need to determine under which conditions. </dd></dl> <p>Reimplemented in <a class="el" href="classyage_1_1Vector.html#a956f7b6d02c0309adece311f59c8beae">yage::Vector< Rows, Type ></a>, <a class="el" href="classyage_1_1Vector.html#a956f7b6d02c0309adece311f59c8beae">yage::Vector< 2, double ></a>, and <a class="el" href="classyage_1_1Vector.html#a956f7b6d02c0309adece311f59c8beae">yage::Vector< 2, Type ></a>.</p> @@ -569,7 +584,7 @@ template<int Rows = 4, int Cols = 4, class Type = double> </div> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> -<li>include/YAGE/Math/<a class="el" href="matrix_8hpp_source.html">matrix.hpp</a></li> +<li>include/YAGE/Math/<a class="el" href="matrix_8h_source.html">matrix.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> @@ -577,7 +592,7 @@ template<int Rows = 4, int Cols = 4, class Type = double> </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="classyage_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> |