/[PAMELA software]/PamCut/doc/Doxygen/html/classSimpleMatrix.html
ViewVC logotype

Annotation of /PamCut/doc/Doxygen/html/classSimpleMatrix.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:05 2009 UTC (15 years, 11 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: text/html
Initial revision

1 pam-fi 1.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&lt; T &gt; 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&nbsp;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&nbsp;List</span></a></li>
19     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21     </ul>
22     </div>
23     </div>
24     <div class="contents">
25     <h1>SimpleMatrix&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="SimpleMatrix" -->A simple matrix class.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>&gt;</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">&nbsp;</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">&nbsp;</td><td class="mdescRight">Constructor. <a href="#9333dc41698c48f4e35d48e27dfe58ef"></a><br></td></tr>
38     <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; T &gt; &amp;&nbsp;</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">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#5cd169cdc38912c3cfb6d0c60e48e042">GetNRows</a> ()</td></tr>
42    
43     <tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#4f168e5b85899788746355ccad15e2fb">GetNCols</a> ()</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of columns. <a href="#4f168e5b85899788746355ccad15e2fb"></a><br></td></tr>
47     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
48     <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::vector&lt; T &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#ddb323741e9ed620a46436037c8d819a">_matrix</a></td></tr>
49    
50     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#984429d26745802dcb3e001ff75246bc">_nRows</a></td></tr>
51    
52     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleMatrix.html#8ea505fb218d273214c2ae6ef45bbc82">_nCols</a></td></tr>
53    
54     </table>
55     <hr><a name="_details"></a><h2>Detailed Description</h2>
56     <h3>template&lt;class T&gt;<br>
57     class SimpleMatrix&lt; T &gt;</h3>
58    
59     A simple matrix class.
60     <p>
61     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 [].
62     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00045">45</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
63     <hr><h2>Constructor &amp; Destructor Documentation</h2>
64     <a class="anchor" name="9333dc41698c48f4e35d48e27dfe58ef"></a><!-- doxytag: member="SimpleMatrix::SimpleMatrix" ref="9333dc41698c48f4e35d48e27dfe58ef" args="(unsigned int nRows, unsigned int nCols, T elements=T())" -->
65     <div class="memitem">
66     <div class="memproto">
67     <div class="memtemplate">
68     template&lt;class T&gt; </div>
69     <table class="memname">
70     <tr>
71     <td class="memname"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::<a class="el" href="classSimpleMatrix.html">SimpleMatrix</a> </td>
72     <td>(</td>
73     <td class="paramtype">unsigned int&nbsp;</td>
74     <td class="paramname"> <em>nRows</em>, </td>
75     </tr>
76     <tr>
77     <td class="paramkey"></td>
78     <td></td>
79     <td class="paramtype">unsigned int&nbsp;</td>
80     <td class="paramname"> <em>nCols</em>, </td>
81     </tr>
82     <tr>
83     <td class="paramkey"></td>
84     <td></td>
85     <td class="paramtype">T&nbsp;</td>
86     <td class="paramname"> <em>elements</em> = <code>T()</code></td><td>&nbsp;</td>
87     </tr>
88     <tr>
89     <td></td>
90     <td>)</td>
91     <td></td><td></td><td><code> [inline]</code></td>
92     </tr>
93     </table>
94     </div>
95     <div class="memdoc">
96    
97     <p>
98     Constructor.
99     <p>
100     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>
101     <dl compact><dt><b>Parameters:</b></dt><dd>
102     <table border="0" cellspacing="2" cellpadding="0">
103     <tr><td valign="top"></td><td valign="top"><em>nRows</em>&nbsp;</td><td>The number of rows. </td></tr>
104     <tr><td valign="top"></td><td valign="top"><em>nCols</em>&nbsp;</td><td>The number of columns </td></tr>
105     <tr><td valign="top"></td><td valign="top"><em>elements</em>&nbsp;</td><td>The initialization value for the matrix elements. </td></tr>
106     </table>
107     </dl>
108    
109     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00058">58</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
110    
111     </div>
112     </div><p>
113     <hr><h2>Member Function Documentation</h2>
114     <a class="anchor" name="4f168e5b85899788746355ccad15e2fb"></a><!-- doxytag: member="SimpleMatrix::GetNCols" ref="4f168e5b85899788746355ccad15e2fb" args="()" -->
115     <div class="memitem">
116     <div class="memproto">
117     <div class="memtemplate">
118     template&lt;class T&gt; </div>
119     <table class="memname">
120     <tr>
121     <td class="memname">unsigned int <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::GetNCols </td>
122     <td>(</td>
123     <td class="paramname"> </td>
124     <td>&nbsp;)&nbsp;</td>
125     <td><code> [inline]</code></td>
126     </tr>
127     </table>
128     </div>
129     <div class="memdoc">
130    
131     <p>
132     Returns the number of columns.
133     <p>
134     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of columns. </dd></dl>
135    
136     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00084">84</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
137    
138     </div>
139     </div><p>
140     <a class="anchor" name="5cd169cdc38912c3cfb6d0c60e48e042"></a><!-- doxytag: member="SimpleMatrix::GetNRows" ref="5cd169cdc38912c3cfb6d0c60e48e042" args="()" -->
141     <div class="memitem">
142     <div class="memproto">
143     <div class="memtemplate">
144     template&lt;class T&gt; </div>
145     <table class="memname">
146     <tr>
147     <td class="memname">unsigned int <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::GetNRows </td>
148     <td>(</td>
149     <td class="paramname"> </td>
150     <td>&nbsp;)&nbsp;</td>
151     <td><code> [inline]</code></td>
152     </tr>
153     </table>
154     </div>
155     <div class="memdoc">
156    
157     <p>
158     Returns the number of rows.
159     <p>
160     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of rows. </dd></dl>
161    
162     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00076">76</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
163    
164     </div>
165     </div><p>
166     <a class="anchor" name="7ee36ef98c7f896e38ec8a8a0c263c39"></a><!-- doxytag: member="SimpleMatrix::operator[]" ref="7ee36ef98c7f896e38ec8a8a0c263c39" args="(int i)" -->
167     <div class="memitem">
168     <div class="memproto">
169     <div class="memtemplate">
170     template&lt;class T&gt; </div>
171     <table class="memname">
172     <tr>
173     <td class="memname">std::vector&lt;T&gt;&amp; <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::operator[] </td>
174     <td>(</td>
175     <td class="paramtype">int&nbsp;</td>
176     <td class="paramname"> <em>i</em> </td>
177     <td>&nbsp;)&nbsp;</td>
178     <td><code> [inline]</code></td>
179     </tr>
180     </table>
181     </div>
182     <div class="memdoc">
183    
184     <p>
185     Standard accessor.
186     <p>
187     <dl compact><dt><b>Parameters:</b></dt><dd>
188     <table border="0" cellspacing="2" cellpadding="0">
189     <tr><td valign="top"></td><td valign="top"><em>i</em>&nbsp;</td><td>The desired row. </td></tr>
190     </table>
191     </dl>
192     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The i-th row (a vector). </dd></dl>
193    
194     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00068">68</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
195    
196     </div>
197     </div><p>
198     <hr><h2>Member Data Documentation</h2>
199     <a class="anchor" name="ddb323741e9ed620a46436037c8d819a"></a><!-- doxytag: member="SimpleMatrix::_matrix" ref="ddb323741e9ed620a46436037c8d819a" args="" -->
200     <div class="memitem">
201     <div class="memproto">
202     <div class="memtemplate">
203     template&lt;class T&gt; </div>
204     <table class="memname">
205     <tr>
206     <td class="memname">std::vector&lt;std::vector&lt;T&gt; &gt; <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::<a class="el" href="classSimpleMatrix.html#ddb323741e9ed620a46436037c8d819a">_matrix</a><code> [private]</code> </td>
207     </tr>
208     </table>
209     </div>
210     <div class="memdoc">
211    
212     <p>
213    
214     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00090">90</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
215    
216     <p>Referenced by <a class="el" href="CommonDefs_8h_source.html#l00068">SimpleMatrix&lt; UInt_t &gt;::operator[]()</a>.</p>
217    
218     </div>
219     </div><p>
220     <a class="anchor" name="8ea505fb218d273214c2ae6ef45bbc82"></a><!-- doxytag: member="SimpleMatrix::_nCols" ref="8ea505fb218d273214c2ae6ef45bbc82" args="" -->
221     <div class="memitem">
222     <div class="memproto">
223     <div class="memtemplate">
224     template&lt;class T&gt; </div>
225     <table class="memname">
226     <tr>
227     <td class="memname">unsigned int <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::<a class="el" href="classSimpleMatrix.html#8ea505fb218d273214c2ae6ef45bbc82">_nCols</a><code> [private]</code> </td>
228     </tr>
229     </table>
230     </div>
231     <div class="memdoc">
232    
233     <p>
234    
235     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00091">91</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
236    
237     <p>Referenced by <a class="el" href="CommonDefs_8h_source.html#l00084">SimpleMatrix&lt; UInt_t &gt;::GetNCols()</a>.</p>
238    
239     </div>
240     </div><p>
241     <a class="anchor" name="984429d26745802dcb3e001ff75246bc"></a><!-- doxytag: member="SimpleMatrix::_nRows" ref="984429d26745802dcb3e001ff75246bc" args="" -->
242     <div class="memitem">
243     <div class="memproto">
244     <div class="memtemplate">
245     template&lt;class T&gt; </div>
246     <table class="memname">
247     <tr>
248     <td class="memname">unsigned int <a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; T &gt;::<a class="el" href="classSimpleMatrix.html#984429d26745802dcb3e001ff75246bc">_nRows</a><code> [private]</code> </td>
249     </tr>
250     </table>
251     </div>
252     <div class="memdoc">
253    
254     <p>
255    
256     <p>Definition at line <a class="el" href="CommonDefs_8h_source.html#l00091">91</a> of file <a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a>.</p>
257    
258     <p>Referenced by <a class="el" href="CommonDefs_8h_source.html#l00076">SimpleMatrix&lt; UInt_t &gt;::GetNRows()</a>.</p>
259    
260     </div>
261     </div><p>
262     <hr>The documentation for this class was generated from the following file:<ul>
263     <li><a class="el" href="CommonDefs_8h_source.html">CommonDefs.h</a></ul>
264     </div>
265     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:42 2009 for PamCut by&nbsp;
266     <a href="http://www.doxygen.org/index.html">
267     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
268     </body>
269     </html>

  ViewVC Help
Powered by ViewVC 1.1.23