diff options
Diffstat (limited to 'classyage_1_1Matrix.html')
| -rw-r--r-- | classyage_1_1Matrix.html | 100 |
1 files changed, 56 insertions, 44 deletions
diff --git a/classyage_1_1Matrix.html b/classyage_1_1Matrix.html index 60572cad..0368df72 100644 --- a/classyage_1_1Matrix.html +++ b/classyage_1_1Matrix.html @@ -22,6 +22,7 @@ <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">YAGE +  <span id="projectnumber">0.02</span> </div> <div id="projectbrief">Yet Another Game Engine</div> </td> @@ -66,83 +67,94 @@ $(function() { <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | -<a href="#friends">Friends</a> | <a href="classyage_1_1Matrix-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">yage::Matrix< Rows, Cols, Type > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> -<p>Base matrix class. +<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> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> +<tr class="memitem:a73b7d1f94f4f72a2294b71b3a35794ad"><td class="memItemLeft" align="right" valign="top"><a id="a73b7d1f94f4f72a2294b71b3a35794ad"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a73b7d1f94f4f72a2294b71b3a35794ad">Matrix</a> ()</td></tr> +<tr class="memdesc:a73b7d1f94f4f72a2294b71b3a35794ad"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the size of the data_ vector. <br /></td></tr> +<tr class="separator:a73b7d1f94f4f72a2294b71b3a35794ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acaf0837fade0cb4179603b97ac224965"><td class="memItemLeft" align="right" valign="top"><a id="acaf0837fade0cb4179603b97ac224965"></a> -int </td><td class="memItemRight" valign="bottom"><b>rowSize</b> () const</td></tr> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#acaf0837fade0cb4179603b97ac224965">rowSize</a> () const</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>. <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"><a id="a2753285bcc49a050a49976a6dbc8e89a"></a> -int </td><td class="memItemRight" valign="bottom"><b>colSize</b> () const</td></tr> +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. <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 id="adffb22a99417271958621ff1f51b7f08"></a> -<a class="el" href="classyage_1_1Matrix.html">Matrix</a>< 1, Cols, Type > </td><td class="memItemRight" valign="bottom"><b>getRow</b> (int row) const</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 id="a2833adcae1e01f637eba251c5aee7888"></a> -<a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, 1, Type > </td><td class="memItemRight" valign="bottom"><b>getCol</b> (int col) const</td></tr> -<tr class="separator:a2833adcae1e01f637eba251c5aee7888"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a83d77d3a40ced5e2b703a6d66b6e6055"><td class="memItemLeft" align="right" valign="top"><a id="a83d77d3a40ced5e2b703a6d66b6e6055"></a> -std::vector< Type >::iterator </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr> -<tr class="separator:a83d77d3a40ced5e2b703a6d66b6e6055"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a20ea5fe16d27ef15f775b5497cadc851"><td class="memItemLeft" align="right" valign="top"><a id="a20ea5fe16d27ef15f775b5497cadc851"></a> -std::vector< Type >::iterator </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr> -<tr class="separator:a20ea5fe16d27ef15f775b5497cadc851"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aaa7273d046ac077da76ffaec876041d7"><td class="memItemLeft" align="right" valign="top"><a id="aaa7273d046ac077da76ffaec876041d7"></a> -virtual std::string </td><td class="memItemRight" valign="bottom"><b>toString</b> () const</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 id="a9dc57c60a19b805a41b8bfb951ce2fef"></a> -<a class="el" href="classyage_1_1detail_1_1Row.html">detail::Row</a>< Rows, Cols, Type > </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (int row)</td></tr> -<tr class="separator:a9dc57c60a19b805a41b8bfb951ce2fef"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ab15e9ff3285806dcb9748edb751b2315"><td class="memItemLeft" align="right" valign="top"><a id="ab15e9ff3285806dcb9748edb751b2315"></a> -<a class="el" href="classyage_1_1detail_1_1Row.html">detail::Row</a>< Rows, Cols, Type > </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (int row) const</td></tr> -<tr class="separator:ab15e9ff3285806dcb9748edb751b2315"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a247d27f88d42f83eb83e855e9f3a82ee"><td class="memItemLeft" align="right" valign="top"><a id="a247d27f88d42f83eb83e855e9f3a82ee"></a> -<a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, Cols, Type > & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, Cols, Type > &other)</td></tr> -<tr class="separator:a247d27f88d42f83eb83e855e9f3a82ee"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8b7e0913efdb5e8c9ff39df4c4f36228"><td class="memItemLeft" align="right" valign="top"><a id="a8b7e0913efdb5e8c9ff39df4c4f36228"></a> -<a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, Cols, Type > & </td><td class="memItemRight" valign="bottom"><b>operator+=</b> (const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, Cols, Type > &rhs)</td></tr> -<tr class="separator:a8b7e0913efdb5e8c9ff39df4c4f36228"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acc2d0763f060c923ce53b37143d0a7bb"><td class="memItemLeft" align="right" valign="top"><a id="acc2d0763f060c923ce53b37143d0a7bb"></a> -<a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, Cols, Type > & </td><td class="memItemRight" valign="bottom"><b>operator-=</b> (const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>< Rows, Cols, Type > &rhs)</td></tr> -<tr class="separator:acc2d0763f060c923ce53b37143d0a7bb"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:a0ab11922319366f6e74f6e9e7d7abeed"><td class="memItemLeft" align="right" valign="top"><a id="a0ab11922319366f6e74f6e9e7d7abeed"></a> -std::vector< Type > </td><td class="memItemRight" valign="bottom"><b>data_</b></td></tr> +std::vector< Type > </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html#a0ab11922319366f6e74f6e9e7d7abeed">data_</a></td></tr> +<tr class="memdesc:a0ab11922319366f6e74f6e9e7d7abeed"><td class="mdescLeft"> </td><td class="mdescRight">Vector containing the data of the matrix. <br /></td></tr> <tr class="separator:a0ab11922319366f6e74f6e9e7d7abeed"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> -Friends</h2></td></tr> -<tr class="memitem:ac06ebbb8e42e63b0707ef44561abcc2e"><td class="memItemLeft" align="right" valign="top"><a id="ac06ebbb8e42e63b0707ef44561abcc2e"></a> -class </td><td class="memItemRight" valign="bottom"><b>detail::Row< Rows, Cols, Type ></b></td></tr> -<tr class="separator:ac06ebbb8e42e63b0707ef44561abcc2e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<int Rows = 4, int Cols = 4, class Type = double><br /> class yage::Matrix< Rows, Cols, Type ></h3> -<p>Base matrix class. </p> -<h1><a class="el" href="classyage_1_1Matrix.html" title="Base matrix class. ">Matrix</a> class </h1> +<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. </p> +<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><hr/>The documentation for this class was generated from the following file:<ul> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="adffb22a99417271958621ff1f51b7f08"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adffb22a99417271958621ff1f51b7f08">◆ </a></span>getRow()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<int Rows = 4, int Cols = 4, class Type = double> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classyage_1_1Matrix.html">Matrix</a><1, Cols, Type> <a class="el" href="classyage_1_1Matrix.html">yage::Matrix</a>< Rows, Cols, Type >::getRow </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>row</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>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. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><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> + +</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> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated by  <a href="http://www.doxygen.org/index.html"> +Generated on Sat Jul 29 2017 10:00:18 for YAGE by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> |