| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>PamCut: SimpleMatrix< T > Class Template Reference</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.9 --> |
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul> |
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul> |
| 15 |
</div> |
| 16 |
<div class="tabs"> |
| 17 |
<ul> |
| 18 |
<li><a href="annotated.html"><span>Class List</span></a></li> |
| 19 |
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| 20 |
<li><a href="functions.html"><span>Class Members</span></a></li> |
| 21 |
</ul> |
| 22 |
</div> |
| 23 |
</div> |
| 24 |
<div class="contents"> |
| 25 |
<h1>SimpleMatrix< T > Class Template Reference</h1><!-- doxytag: class="SimpleMatrix" -->A simple matrix class. |
| 26 |
<a href="#_details">More...</a> |
| 27 |
<p> |
| 28 |
<code>#include <<a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>></code> |
| 29 |
<p> |
| 30 |
|
| 31 |
<p> |
| 32 |
<a href="classSimpleMatrix-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 33 |
<tr><td></td></tr> |
| 34 |
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#9333dc41698c48f4e35d48e27dfe58ef">SimpleMatrix</a> (unsigned int nRows, unsigned int nCols, T elements=T())</td></tr> |
| 36 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#9333dc41698c48f4e35d48e27dfe58ef"></a><br></td></tr> |
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#7ee36ef98c7f896e38ec8a8a0c263c39">operator[]</a> (int i)</td></tr> |
| 39 |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Standard accessor. <a href="#7ee36ef98c7f896e38ec8a8a0c263c39"></a><br></td></tr> |
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#5cd169cdc38912c3cfb6d0c60e48e042">GetNRows</a> ()</td></tr> |
| 42 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of rows. <a href="#5cd169cdc38912c3cfb6d0c60e48e042"></a><br></td></tr> |
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#4f168e5b85899788746355ccad15e2fb">GetNCols</a> ()</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of columns. <a href="#4f168e5b85899788746355ccad15e2fb"></a><br></td></tr> |
| 47 |
</table> |
| 48 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 49 |
<h3>template<class T><br> |
| 50 |
class SimpleMatrix< T ></h3> |
| 51 |
|
| 52 |
A simple matrix class. |
| 53 |
<p> |
| 54 |
This class defines a matrix built by STL vectors. It is basically a variable-dimension vector of vectors; the dimension is defined at construction and cannot be changed in current implementation. It is intended as a container and not for algebraic manipulations. The class provides a standard access operator []. <hr><h2>Constructor & Destructor Documentation</h2> |
| 55 |
<a class="anchor" name="9333dc41698c48f4e35d48e27dfe58ef"></a><!-- doxytag: member="SimpleMatrix::SimpleMatrix" ref="9333dc41698c48f4e35d48e27dfe58ef" args="(unsigned int nRows, unsigned int nCols, T elements=T())" --> |
| 56 |
<div class="memitem"> |
| 57 |
<div class="memproto"> |
| 58 |
<div class="memtemplate"> |
| 59 |
template<class T> </div> |
| 60 |
<table class="memname"> |
| 61 |
<tr> |
| 62 |
<td class="memname"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>< T >::<a class="el" href="classSimpleMatrix.html">SimpleMatrix</a> </td> |
| 63 |
<td>(</td> |
| 64 |
<td class="paramtype">unsigned int </td> |
| 65 |
<td class="paramname"> <em>nRows</em>, </td> |
| 66 |
</tr> |
| 67 |
<tr> |
| 68 |
<td class="paramkey"></td> |
| 69 |
<td></td> |
| 70 |
<td class="paramtype">unsigned int </td> |
| 71 |
<td class="paramname"> <em>nCols</em>, </td> |
| 72 |
</tr> |
| 73 |
<tr> |
| 74 |
<td class="paramkey"></td> |
| 75 |
<td></td> |
| 76 |
<td class="paramtype">T </td> |
| 77 |
<td class="paramname"> <em>elements</em> = <code>T()</code></td><td> </td> |
| 78 |
</tr> |
| 79 |
<tr> |
| 80 |
<td></td> |
| 81 |
<td>)</td> |
| 82 |
<td></td><td></td><td><code> [inline]</code></td> |
| 83 |
</tr> |
| 84 |
</table> |
| 85 |
</div> |
| 86 |
<div class="memdoc"> |
| 87 |
|
| 88 |
<p> |
| 89 |
Constructor. |
| 90 |
<p> |
| 91 |
The constructor will build an nRows x nCols matrix, initialized with a default value. If T is a class with no default constructor, a default value for T must be provided, which will be replicated in every matrix element.<p> |
| 92 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 93 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 94 |
<tr><td valign="top"></td><td valign="top"><em>nRows</em> </td><td>The number of rows. </td></tr> |
| 95 |
<tr><td valign="top"></td><td valign="top"><em>nCols</em> </td><td>The number of columns </td></tr> |
| 96 |
<tr><td valign="top"></td><td valign="top"><em>elements</em> </td><td>The initialization value for the matrix elements. </td></tr> |
| 97 |
</table> |
| 98 |
</dl> |
| 99 |
|
| 100 |
</div> |
| 101 |
</div><p> |
| 102 |
<hr><h2>Member Function Documentation</h2> |
| 103 |
<a class="anchor" name="4f168e5b85899788746355ccad15e2fb"></a><!-- doxytag: member="SimpleMatrix::GetNCols" ref="4f168e5b85899788746355ccad15e2fb" args="()" --> |
| 104 |
<div class="memitem"> |
| 105 |
<div class="memproto"> |
| 106 |
<div class="memtemplate"> |
| 107 |
template<class T> </div> |
| 108 |
<table class="memname"> |
| 109 |
<tr> |
| 110 |
<td class="memname">unsigned int <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>< T >::GetNCols </td> |
| 111 |
<td>(</td> |
| 112 |
<td class="paramname"> </td> |
| 113 |
<td> ) </td> |
| 114 |
<td><code> [inline]</code></td> |
| 115 |
</tr> |
| 116 |
</table> |
| 117 |
</div> |
| 118 |
<div class="memdoc"> |
| 119 |
|
| 120 |
<p> |
| 121 |
Returns the number of columns. |
| 122 |
<p> |
| 123 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of columns. </dd></dl> |
| 124 |
|
| 125 |
</div> |
| 126 |
</div><p> |
| 127 |
<a class="anchor" name="5cd169cdc38912c3cfb6d0c60e48e042"></a><!-- doxytag: member="SimpleMatrix::GetNRows" ref="5cd169cdc38912c3cfb6d0c60e48e042" args="()" --> |
| 128 |
<div class="memitem"> |
| 129 |
<div class="memproto"> |
| 130 |
<div class="memtemplate"> |
| 131 |
template<class T> </div> |
| 132 |
<table class="memname"> |
| 133 |
<tr> |
| 134 |
<td class="memname">unsigned int <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>< T >::GetNRows </td> |
| 135 |
<td>(</td> |
| 136 |
<td class="paramname"> </td> |
| 137 |
<td> ) </td> |
| 138 |
<td><code> [inline]</code></td> |
| 139 |
</tr> |
| 140 |
</table> |
| 141 |
</div> |
| 142 |
<div class="memdoc"> |
| 143 |
|
| 144 |
<p> |
| 145 |
Returns the number of rows. |
| 146 |
<p> |
| 147 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of rows. </dd></dl> |
| 148 |
|
| 149 |
</div> |
| 150 |
</div><p> |
| 151 |
<a class="anchor" name="7ee36ef98c7f896e38ec8a8a0c263c39"></a><!-- doxytag: member="SimpleMatrix::operator[]" ref="7ee36ef98c7f896e38ec8a8a0c263c39" args="(int i)" --> |
| 152 |
<div class="memitem"> |
| 153 |
<div class="memproto"> |
| 154 |
<div class="memtemplate"> |
| 155 |
template<class T> </div> |
| 156 |
<table class="memname"> |
| 157 |
<tr> |
| 158 |
<td class="memname">std::vector<T>& <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>< T >::operator[] </td> |
| 159 |
<td>(</td> |
| 160 |
<td class="paramtype">int </td> |
| 161 |
<td class="paramname"> <em>i</em> </td> |
| 162 |
<td> ) </td> |
| 163 |
<td><code> [inline]</code></td> |
| 164 |
</tr> |
| 165 |
</table> |
| 166 |
</div> |
| 167 |
<div class="memdoc"> |
| 168 |
|
| 169 |
<p> |
| 170 |
Standard accessor. |
| 171 |
<p> |
| 172 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 173 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 174 |
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The desired row. </td></tr> |
| 175 |
</table> |
| 176 |
</dl> |
| 177 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The i-th row (a vector). </dd></dl> |
| 178 |
|
| 179 |
</div> |
| 180 |
</div><p> |
| 181 |
<hr>The documentation for this class was generated from the following file:<ul> |
| 182 |
<li><a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a></ul> |
| 183 |
</div> |
| 184 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:04 2009 for PamCut by |
| 185 |
<a href="http://www.doxygen.org/index.html"> |
| 186 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 187 |
</body> |
| 188 |
</html> |
Parent Directory
| 
Revision Log