1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
4 | <head> |
---|
5 | <meta name="generator" content= |
---|
6 | "HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" /> |
---|
7 | <meta http-equiv="Content-Type" content= |
---|
8 | "text/html; charset=us-ascii" /> |
---|
9 | <link href="ublas.css" type="text/css" /> |
---|
10 | <title>Triangular Matrix</title> |
---|
11 | </head> |
---|
12 | <body> |
---|
13 | <h1><img src="../../../../boost.png" align="middle" /> |
---|
14 | Triangular Matrix</h1> |
---|
15 | <h2><a name="triangular_matrix" id="triangular_matrix"></a>Triangular Matrix</h2> |
---|
16 | <h4>Description</h4> |
---|
17 | <p>The templated class <code>triangular_matrix<T, F1, F2, |
---|
18 | A></code> is the base container adaptor for triangular matrices. |
---|
19 | For a <em>(n x n</em> )-dimensional lower triangular matrix and |
---|
20 | <em>0 <= i < n</em>,<em>0 <= j < n</em> holds |
---|
21 | <em>t</em><sub><em>i, j</em></sub> <em>= 0</em> , if <em>i > |
---|
22 | j</em>. If furthermore holds t<sub><em>i, i</em></sub><em>= 1</em> |
---|
23 | the matrix is called unit lower triangular. For a <em>(n x n</em> |
---|
24 | )-dimensional upper triangular matrix and <em>0 <= i < |
---|
25 | n</em>,<em>0 <= j < n</em> holds <em>t</em><sub><em>i, |
---|
26 | j</em></sub> <em>= 0</em> , if <em>i < j</em>. If furthermore |
---|
27 | holds t<sub><em>i, i</em></sub><em>= 1</em> the matrix is called |
---|
28 | unit lower triangular. The storage of triangular matrices is |
---|
29 | packed.</p> |
---|
30 | <h4>Example</h4> |
---|
31 | <pre> |
---|
32 | #include <boost/numeric/ublas/triangular.hpp> |
---|
33 | #include <boost/numeric/ublas/io.hpp> |
---|
34 | |
---|
35 | int main () { |
---|
36 | using namespace boost::numeric::ublas; |
---|
37 | triangular_matrix<double, lower> ml (3, 3); |
---|
38 | for (unsigned i = 0; i < ml.size1 (); ++ i) |
---|
39 | for (unsigned j = 0; j <= i; ++ j) |
---|
40 | ml (i, j) = 3 * i + j; |
---|
41 | std::cout << ml << std::endl; |
---|
42 | triangular_matrix<double, upper> mu (3, 3); |
---|
43 | for (unsigned i = 0; i < mu.size1 (); ++ i) |
---|
44 | for (unsigned j = i; j < mu.size2 (); ++ j) |
---|
45 | mu (i, j) = 3 * i + j; |
---|
46 | std::cout << mu << std::endl; |
---|
47 | } |
---|
48 | </pre> |
---|
49 | <h4>Definition</h4> |
---|
50 | <p>Defined in the header triangular.hpp.</p> |
---|
51 | <h4>Template parameters</h4> |
---|
52 | <table border="1" summary="parameters"> |
---|
53 | <tbody> |
---|
54 | <tr> |
---|
55 | <th>Parameter</th> |
---|
56 | <th>Description</th> |
---|
57 | <th>Default</th> |
---|
58 | </tr> |
---|
59 | <tr> |
---|
60 | <td><code>T</code></td> |
---|
61 | <td>The type of object stored in the matrix.</td> |
---|
62 | <td></td> |
---|
63 | </tr> |
---|
64 | <tr> |
---|
65 | <td><code>F1</code></td> |
---|
66 | <td>Functor describing the type of the triangular matrix. <a href= |
---|
67 | "#triangular_matrix_1">[1]</a></td> |
---|
68 | <td><code>lower</code></td> |
---|
69 | </tr> |
---|
70 | <tr> |
---|
71 | <td><code>F2</code></td> |
---|
72 | <td>Functor describing the storage organization. <a href= |
---|
73 | "#triangular_matrix_2">[2]</a></td> |
---|
74 | <td><code>row_major</code></td> |
---|
75 | </tr> |
---|
76 | <tr> |
---|
77 | <td><code>A</code></td> |
---|
78 | <td>The type of the adapted array. <a href= |
---|
79 | "#triangular_matrix_3">[3]</a></td> |
---|
80 | <td><code>unbounded_array<T></code></td> |
---|
81 | </tr> |
---|
82 | </tbody> |
---|
83 | </table> |
---|
84 | <h4>Model of</h4> |
---|
85 | <p><a href="container_concept.htm#matrix">Matrix</a> .</p> |
---|
86 | <h4>Type requirements</h4> |
---|
87 | <p>None, except for those imposed by the requirements of <a href= |
---|
88 | "container_concept.htm#matrix">Matrix</a> .</p> |
---|
89 | <h4>Public base classes</h4> |
---|
90 | <p><code>matrix_container<triangular_matrix<T, F1, F2, A> |
---|
91 | ></code></p> |
---|
92 | <h4>Members</h4> |
---|
93 | <table border="1" summary="members"> |
---|
94 | <tbody> |
---|
95 | <tr> |
---|
96 | <th>Member</th> |
---|
97 | <th>Description</th> |
---|
98 | </tr> |
---|
99 | <tr> |
---|
100 | <td><code>triangular_matrix ()</code></td> |
---|
101 | <td>Allocates an uninitialized <code>triangular_matrix</code> that |
---|
102 | holds zero rows of zero elements.</td> |
---|
103 | </tr> |
---|
104 | <tr> |
---|
105 | <td><code>triangular_matrix (size_type size1, size_type |
---|
106 | size2)</code></td> |
---|
107 | <td>Allocates an uninitialized <code>triangular_matrix</code> that |
---|
108 | holds <code>size1</code> rows of <code>size2</code> elements.</td> |
---|
109 | </tr> |
---|
110 | <tr> |
---|
111 | <td><code>triangular_matrix (const triangular_matrix |
---|
112 | &m)</code></td> |
---|
113 | <td>The copy constructor.</td> |
---|
114 | </tr> |
---|
115 | <tr> |
---|
116 | <td><code>template<class AE><br /> |
---|
117 | triangular_matrix (const matrix_expression<AE> |
---|
118 | &ae)</code></td> |
---|
119 | <td>The extended copy constructor.</td> |
---|
120 | </tr> |
---|
121 | <tr> |
---|
122 | <td><code>void resize (size_type size1, size_type size2, bool |
---|
123 | preserve = true)</code></td> |
---|
124 | <td>Reallocates a <code>triangular_matrix</code> to hold |
---|
125 | <code>size1</code> rows of <code>size2</code> elements. The |
---|
126 | existing elements of the <code>triangular_matrix</code> are |
---|
127 | preseved when specified.</td> |
---|
128 | </tr> |
---|
129 | <tr> |
---|
130 | <td><code>size_type size1 () const</code></td> |
---|
131 | <td>Returns the number of rows.</td> |
---|
132 | </tr> |
---|
133 | <tr> |
---|
134 | <td><code>size_type size2 () const</code></td> |
---|
135 | <td>Returns the number of columns.</td> |
---|
136 | </tr> |
---|
137 | <tr> |
---|
138 | <td><code>const_reference operator () (size_type i, size_type j) |
---|
139 | const</code></td> |
---|
140 | <td>Returns a <code>const</code> reference of the <code>j</code> |
---|
141 | -th element in the <code>i</code>-th row.</td> |
---|
142 | </tr> |
---|
143 | <tr> |
---|
144 | <td><code>reference operator () (size_type i, size_type |
---|
145 | j)</code></td> |
---|
146 | <td>Returns a reference of the <code>j</code>-th element in the |
---|
147 | <code>i</code>-th row.</td> |
---|
148 | </tr> |
---|
149 | <tr> |
---|
150 | <td><code>triangular_matrix &operator = (const |
---|
151 | triangular_matrix &m)</code></td> |
---|
152 | <td>The assignment operator.</td> |
---|
153 | </tr> |
---|
154 | <tr> |
---|
155 | <td><code>triangular_matrix &assign_temporary |
---|
156 | (triangular_matrix &m)</code></td> |
---|
157 | <td>Assigns a temporary. May change the triangular matrix |
---|
158 | <code>m</code>.</td> |
---|
159 | </tr> |
---|
160 | <tr> |
---|
161 | <td><code>template<class AE><br /> |
---|
162 | triangular_matrix &operator = (const |
---|
163 | matrix_expression<AE> &ae)</code></td> |
---|
164 | <td>The extended assignment operator.</td> |
---|
165 | </tr> |
---|
166 | <tr> |
---|
167 | <td><code>template<class AE><br /> |
---|
168 | triangular_matrix &assign (const matrix_expression<AE> |
---|
169 | &ae)</code></td> |
---|
170 | <td>Assigns a matrix expression to the triangular matrix. Left and |
---|
171 | right hand side of the assignment should be independent.</td> |
---|
172 | </tr> |
---|
173 | <tr> |
---|
174 | <td><code>template<class AE><br /> |
---|
175 | triangular_matrix &operator += (const |
---|
176 | matrix_expression<AE> &ae)</code></td> |
---|
177 | <td>A computed assignment operator. Adds the matrix expression to |
---|
178 | the triangular matrix.</td> |
---|
179 | </tr> |
---|
180 | <tr> |
---|
181 | <td><code>template<class AE><br /> |
---|
182 | triangular_matrix &plus_assign (const |
---|
183 | matrix_expression<AE> &ae)</code></td> |
---|
184 | <td>Adds a matrix expression to the triangular matrix. Left and |
---|
185 | right hand side of the assignment should be independent.</td> |
---|
186 | </tr> |
---|
187 | <tr> |
---|
188 | <td><code>template<class AE><br /> |
---|
189 | triangular_matrix &operator -= (const |
---|
190 | matrix_expression<AE> &ae)</code></td> |
---|
191 | <td>A computed assignment operator. Subtracts the matrix expression |
---|
192 | from the triangular matrix.</td> |
---|
193 | </tr> |
---|
194 | <tr> |
---|
195 | <td><code>template<class AE><br /> |
---|
196 | triangular_matrix &minus_assign (const |
---|
197 | matrix_expression<AE> &ae)</code></td> |
---|
198 | <td>Subtracts a matrix expression from the triangular matrix. Left |
---|
199 | and right hand side of the assignment should be independent.</td> |
---|
200 | </tr> |
---|
201 | <tr> |
---|
202 | <td><code>template<class AT><br /> |
---|
203 | triangular_matrix &operator *= (const AT &at)</code></td> |
---|
204 | <td>A computed assignment operator. Multiplies the triangular |
---|
205 | matrix with a scalar.</td> |
---|
206 | </tr> |
---|
207 | <tr> |
---|
208 | <td><code>template<class AT><br /> |
---|
209 | triangular_matrix &operator /= (const AT &at)</code></td> |
---|
210 | <td>A computed assignment operator. Divides the triangular matrix |
---|
211 | through a scalar.</td> |
---|
212 | </tr> |
---|
213 | <tr> |
---|
214 | <td><code>void swap (triangular_matrix &m)</code></td> |
---|
215 | <td>Swaps the contents of the triangular matrices.</td> |
---|
216 | </tr> |
---|
217 | <tr> |
---|
218 | <td><code>void insert (size_type i, size_type j, const_reference |
---|
219 | t)</code></td> |
---|
220 | <td>Inserts the value <code>t</code> at the <code>j</code>-th |
---|
221 | element of the <code>i</code>-th row.</td> |
---|
222 | </tr> |
---|
223 | <tr> |
---|
224 | <td><code>void erase (size_type i, size_type j)</code></td> |
---|
225 | <td>Erases the value at the <code>j</code>-th elemenst of the |
---|
226 | <code>i</code>-th row.</td> |
---|
227 | </tr> |
---|
228 | <tr> |
---|
229 | <td><code>void clear ()</code></td> |
---|
230 | <td>Clears the matrix.</td> |
---|
231 | </tr> |
---|
232 | <tr> |
---|
233 | <td><code>const_iterator1 begin1 () const</code></td> |
---|
234 | <td>Returns a <code>const_iterator1</code> pointing to the |
---|
235 | beginning of the <code>triangular_matrix</code>.</td> |
---|
236 | </tr> |
---|
237 | <tr> |
---|
238 | <td><code>const_iterator1 end1 () const</code></td> |
---|
239 | <td>Returns a <code>const_iterator1</code> pointing to the end of |
---|
240 | the <code>triangular_matrix</code>.</td> |
---|
241 | </tr> |
---|
242 | <tr> |
---|
243 | <td><code>iterator1 begin1 ()</code></td> |
---|
244 | <td>Returns a <code>iterator1</code> pointing to the beginning of |
---|
245 | the <code>triangular_matrix</code>.</td> |
---|
246 | </tr> |
---|
247 | <tr> |
---|
248 | <td><code>iterator1 end1 ()</code></td> |
---|
249 | <td>Returns a <code>iterator1</code> pointing to the end of the |
---|
250 | <code>triangular_matrix</code>.</td> |
---|
251 | </tr> |
---|
252 | <tr> |
---|
253 | <td><code>const_iterator2 begin2 () const</code></td> |
---|
254 | <td>Returns a <code>const_iterator2</code> pointing to the |
---|
255 | beginning of the <code>triangular_matrix</code>.</td> |
---|
256 | </tr> |
---|
257 | <tr> |
---|
258 | <td><code>const_iterator2 end2 () const</code></td> |
---|
259 | <td>Returns a <code>const_iterator2</code> pointing to the end of |
---|
260 | the <code>triangular_matrix</code>.</td> |
---|
261 | </tr> |
---|
262 | <tr> |
---|
263 | <td><code>iterator2 begin2 ()</code></td> |
---|
264 | <td>Returns a <code>iterator2</code> pointing to the beginning of |
---|
265 | the <code>triangular_matrix</code>.</td> |
---|
266 | </tr> |
---|
267 | <tr> |
---|
268 | <td><code>iterator2 end2 ()</code></td> |
---|
269 | <td>Returns a <code>iterator2</code> pointing to the end of the |
---|
270 | <code>triangular_matrix</code>.</td> |
---|
271 | </tr> |
---|
272 | <tr> |
---|
273 | <td><code>const_reverse_iterator1 rbegin1 () const</code></td> |
---|
274 | <td>Returns a <code>const_reverse_iterator1</code> pointing to the |
---|
275 | beginning of the reversed <code>triangular_matrix</code>.</td> |
---|
276 | </tr> |
---|
277 | <tr> |
---|
278 | <td><code>const_reverse_iterator1 rend1 () const</code></td> |
---|
279 | <td>Returns a <code>const_reverse_iterator1</code> pointing to the |
---|
280 | end of the reversed <code>triangular_matrix</code>.</td> |
---|
281 | </tr> |
---|
282 | <tr> |
---|
283 | <td><code>reverse_iterator1 rbegin1 ()</code></td> |
---|
284 | <td>Returns a <code>reverse_iterator1</code> pointing to the |
---|
285 | beginning of the reversed <code>triangular_matrix</code>.</td> |
---|
286 | </tr> |
---|
287 | <tr> |
---|
288 | <td><code>reverse_iterator1 rend1 ()</code></td> |
---|
289 | <td>Returns a <code>reverse_iterator1</code> pointing to the end of |
---|
290 | the reversed <code>triangular_matrix</code>.</td> |
---|
291 | </tr> |
---|
292 | <tr> |
---|
293 | <td><code>const_reverse_iterator2 rbegin2 () const</code></td> |
---|
294 | <td>Returns a <code>const_reverse_iterator2</code> pointing to the |
---|
295 | beginning of the reversed <code>triangular_matrix</code>.</td> |
---|
296 | </tr> |
---|
297 | <tr> |
---|
298 | <td><code>const_reverse_iterator2 rend2 () const</code></td> |
---|
299 | <td>Returns a <code>const_reverse_iterator2</code> pointing to the |
---|
300 | end of the reversed <code>triangular_matrix</code>.</td> |
---|
301 | </tr> |
---|
302 | <tr> |
---|
303 | <td><code>reverse_iterator2 rbegin2 ()</code></td> |
---|
304 | <td>Returns a <code>reverse_iterator2</code> pointing to the |
---|
305 | beginning of the reversed <code>triangular_matrix</code>.</td> |
---|
306 | </tr> |
---|
307 | <tr> |
---|
308 | <td><code>reverse_iterator2 rend2 ()</code></td> |
---|
309 | <td>Returns a <code>reverse_iterator2</code> pointing to the end of |
---|
310 | the reversed <code>triangular_matrix</code>.</td> |
---|
311 | </tr> |
---|
312 | </tbody> |
---|
313 | </table> |
---|
314 | <h4>Notes</h4> |
---|
315 | <p><a name="triangular_matrix_1" id="triangular_matrix_1">[1]</a> |
---|
316 | Supported parameters for the type of the triangular matrix are |
---|
317 | <code>lower</code> , <code>unit_lower</code>, <code>upper</code> |
---|
318 | and <code>unit_upper</code> .</p> |
---|
319 | <p><a name="triangular_matrix_2" id="triangular_matrix_2">[2]</a> |
---|
320 | Supported parameters for the storage organization are |
---|
321 | <code>row_major</code> and <code>column_major</code>.</p> |
---|
322 | <p><a name="triangular_matrix_3" id="triangular_matrix_3">[3]</a> |
---|
323 | Supported parameters for the adapted array are |
---|
324 | <code>unbounded_array<T></code> , |
---|
325 | <code>bounded_array<T></code> and |
---|
326 | <code>std::vector<T></code> .</p> |
---|
327 | <h2><a name="triangular_adaptor" id="triangular_adaptor"></a>Triangular Adaptor</h2> |
---|
328 | <h4>Description</h4> |
---|
329 | <p>The templated class <code>triangular_adaptor<M, F></code> |
---|
330 | is a triangular matrix adaptor for other matrices.</p> |
---|
331 | <h4>Example</h4> |
---|
332 | <pre> |
---|
333 | #include <boost/numeric/ublas/triangular.hpp> |
---|
334 | #include <boost/numeric/ublas/io.hpp> |
---|
335 | |
---|
336 | int main () { |
---|
337 | using namespace boost::numeric::ublas; |
---|
338 | matrix<double> m (3, 3); |
---|
339 | triangular_adaptor<matrix<double>, lower> tal (m); |
---|
340 | for (unsigned i = 0; i < tal.size1 (); ++ i) |
---|
341 | for (unsigned j = 0; j <= i; ++ j) |
---|
342 | tal (i, j) = 3 * i + j; |
---|
343 | std::cout << tal << std::endl; |
---|
344 | triangular_adaptor<matrix<double>, upper> tau (m); |
---|
345 | for (unsigned i = 0; i < tau.size1 (); ++ i) |
---|
346 | for (unsigned j = i; j < tau.size2 (); ++ j) |
---|
347 | tau (i, j) = 3 * i + j; |
---|
348 | std::cout << tau << std::endl; |
---|
349 | } |
---|
350 | </pre> |
---|
351 | <h4>Definition</h4> |
---|
352 | <p>Defined in the header triangular.hpp.</p> |
---|
353 | <h4>Template parameters</h4> |
---|
354 | <table border="1" summary="parameters"> |
---|
355 | <tbody> |
---|
356 | <tr> |
---|
357 | <th>Parameter</th> |
---|
358 | <th>Description</th> |
---|
359 | <th>Default</th> |
---|
360 | </tr> |
---|
361 | <tr> |
---|
362 | <td><code>M</code></td> |
---|
363 | <td>The type of the adapted matrix.</td> |
---|
364 | <td></td> |
---|
365 | </tr> |
---|
366 | <tr> |
---|
367 | <td><code>F</code></td> |
---|
368 | <td>Functor describing the type of the triangular adaptor. <a href= |
---|
369 | "#triangular_adaptor_1">[1]</a></td> |
---|
370 | <td><code>lower</code></td> |
---|
371 | </tr> |
---|
372 | </tbody> |
---|
373 | </table> |
---|
374 | <h4>Model of</h4> |
---|
375 | <p><a href="expression_concept.htm#matrix_expression">Matrix Expression</a> |
---|
376 | .</p> |
---|
377 | <h4>Type requirements</h4> |
---|
378 | <p>None, except for those imposed by the requirements of <a href= |
---|
379 | "expression_concept.htm#matrix_expression">Matrix Expression</a> .</p> |
---|
380 | <h4>Public base classes</h4> |
---|
381 | <p><code>matrix_expression<triangular_adaptor<M, F> |
---|
382 | ></code></p> |
---|
383 | <h4>Members</h4> |
---|
384 | <table border="1" summary="members"> |
---|
385 | <tbody> |
---|
386 | <tr> |
---|
387 | <th>Member</th> |
---|
388 | <th>Description</th> |
---|
389 | </tr> |
---|
390 | <tr> |
---|
391 | <td><code>triangular_adaptor (matrix_type &data)</code></td> |
---|
392 | <td>Constructs a <code>triangular_adaptor</code> of a matrix.</td> |
---|
393 | </tr> |
---|
394 | <tr> |
---|
395 | <td><code>triangular_adaptor (const triangular_adaptor |
---|
396 | &m)</code></td> |
---|
397 | <td>The copy constructor.</td> |
---|
398 | </tr> |
---|
399 | <tr> |
---|
400 | <td><code>template<class AE><br /> |
---|
401 | triangular_adaptor (const matrix_expression<AE> |
---|
402 | &ae)</code></td> |
---|
403 | <td>The extended copy constructor.</td> |
---|
404 | </tr> |
---|
405 | <tr> |
---|
406 | <td><code>size_type size1 () const</code></td> |
---|
407 | <td>Returns the number of rows.</td> |
---|
408 | </tr> |
---|
409 | <tr> |
---|
410 | <td><code>size_type size2 () const</code></td> |
---|
411 | <td>Returns the number of columns.</td> |
---|
412 | </tr> |
---|
413 | <tr> |
---|
414 | <td><code>const_reference operator () (size_type i, size_type j) |
---|
415 | const</code></td> |
---|
416 | <td>Returns a <code>const</code> reference of the <code>j</code> |
---|
417 | -th element in the <code>i</code>-th row.</td> |
---|
418 | </tr> |
---|
419 | <tr> |
---|
420 | <td><code>reference operator () (size_type i, size_type |
---|
421 | j)</code></td> |
---|
422 | <td>Returns a reference of the <code>j</code>-th element in the |
---|
423 | <code>i</code>-th row.</td> |
---|
424 | </tr> |
---|
425 | <tr> |
---|
426 | <td><code>triangular_adaptor &operator = (const |
---|
427 | triangular_adaptor &m)</code></td> |
---|
428 | <td>The assignment operator.</td> |
---|
429 | </tr> |
---|
430 | <tr> |
---|
431 | <td><code>triangular_adaptor &assign_temporary |
---|
432 | (triangular_adaptor &m)</code></td> |
---|
433 | <td>Assigns a temporary. May change the triangular adaptor |
---|
434 | <code>m</code>.</td> |
---|
435 | </tr> |
---|
436 | <tr> |
---|
437 | <td><code>template<class AE><br /> |
---|
438 | triangular_adaptor &operator = (const |
---|
439 | matrix_expression<AE> &ae)</code></td> |
---|
440 | <td>The extended assignment operator.</td> |
---|
441 | </tr> |
---|
442 | <tr> |
---|
443 | <td><code>template<class AE><br /> |
---|
444 | triangular_adaptor &assign (const matrix_expression<AE> |
---|
445 | &ae)</code></td> |
---|
446 | <td>Assigns a matrix expression to the triangular adaptor. Left and |
---|
447 | right hand side of the assignment should be independent.</td> |
---|
448 | </tr> |
---|
449 | <tr> |
---|
450 | <td><code>template<class AE><br /> |
---|
451 | triangular_adaptor &operator += (const |
---|
452 | matrix_expression<AE> &ae)</code></td> |
---|
453 | <td>A computed assignment operator. Adds the matrix expression to |
---|
454 | the triangular adaptor.</td> |
---|
455 | </tr> |
---|
456 | <tr> |
---|
457 | <td><code>template<class AE><br /> |
---|
458 | triangular_adaptor &plus_assign (const |
---|
459 | matrix_expression<AE> &ae)</code></td> |
---|
460 | <td>Adds a matrix expression to the triangular adaptor. Left and |
---|
461 | right hand side of the assignment should be independent.</td> |
---|
462 | </tr> |
---|
463 | <tr> |
---|
464 | <td><code>template<class AE><br /> |
---|
465 | triangular_adaptor &operator -= (const |
---|
466 | matrix_expression<AE> &ae)</code></td> |
---|
467 | <td>A computed assignment operator. Subtracts the matrix expression |
---|
468 | from the triangular adaptor.</td> |
---|
469 | </tr> |
---|
470 | <tr> |
---|
471 | <td><code>template<class AE><br /> |
---|
472 | triangular_adaptor &minus_assign (const |
---|
473 | matrix_expression<AE> &ae)</code></td> |
---|
474 | <td>Subtracts a matrix expression from the triangular adaptor. Left |
---|
475 | and right hand side of the assignment should be independent.</td> |
---|
476 | </tr> |
---|
477 | <tr> |
---|
478 | <td><code>template<class AT><br /> |
---|
479 | triangular_adaptor &operator *= (const AT &at)</code></td> |
---|
480 | <td>A computed assignment operator. Multiplies the triangular |
---|
481 | adaptor with a scalar.</td> |
---|
482 | </tr> |
---|
483 | <tr> |
---|
484 | <td><code>template<class AT><br /> |
---|
485 | triangular_adaptor &operator /= (const AT &at)</code></td> |
---|
486 | <td>A computed assignment operator. Divides the triangular adaptor |
---|
487 | through a scalar.</td> |
---|
488 | </tr> |
---|
489 | <tr> |
---|
490 | <td><code>void swap (triangular_adaptor &m)</code></td> |
---|
491 | <td>Swaps the contents of the triangular adaptors.</td> |
---|
492 | </tr> |
---|
493 | <tr> |
---|
494 | <td><code>const_iterator1 begin1 () const</code></td> |
---|
495 | <td>Returns a <code>const_iterator1</code> pointing to the |
---|
496 | beginning of the <code>triangular_adaptor</code>.</td> |
---|
497 | </tr> |
---|
498 | <tr> |
---|
499 | <td><code>const_iterator1 end1 () const</code></td> |
---|
500 | <td>Returns a <code>const_iterator1</code> pointing to the end of |
---|
501 | the <code>triangular_adaptor</code>.</td> |
---|
502 | </tr> |
---|
503 | <tr> |
---|
504 | <td><code>iterator1 begin1 ()</code></td> |
---|
505 | <td>Returns a <code>iterator1</code> pointing to the beginning of |
---|
506 | the <code>triangular_adaptor</code>.</td> |
---|
507 | </tr> |
---|
508 | <tr> |
---|
509 | <td><code>iterator1 end1 ()</code></td> |
---|
510 | <td>Returns a <code>iterator1</code> pointing to the end of the |
---|
511 | <code>triangular_adaptor</code>.</td> |
---|
512 | </tr> |
---|
513 | <tr> |
---|
514 | <td><code>const_iterator2 begin2 () const</code></td> |
---|
515 | <td>Returns a <code>const_iterator2</code> pointing to the |
---|
516 | beginning of the <code>triangular_adaptor</code>.</td> |
---|
517 | </tr> |
---|
518 | <tr> |
---|
519 | <td><code>const_iterator2 end2 () const</code></td> |
---|
520 | <td>Returns a <code>const_iterator2</code> pointing to the end of |
---|
521 | the <code>triangular_adaptor</code>.</td> |
---|
522 | </tr> |
---|
523 | <tr> |
---|
524 | <td><code>iterator2 begin2 ()</code></td> |
---|
525 | <td>Returns a <code>iterator2</code> pointing to the beginning of |
---|
526 | the <code>triangular_adaptor</code>.</td> |
---|
527 | </tr> |
---|
528 | <tr> |
---|
529 | <td><code>iterator2 end2 ()</code></td> |
---|
530 | <td>Returns a <code>iterator2</code> pointing to the end of the |
---|
531 | <code>triangular_adaptor</code>.</td> |
---|
532 | </tr> |
---|
533 | <tr> |
---|
534 | <td><code>const_reverse_iterator1 rbegin1 () const</code></td> |
---|
535 | <td>Returns a <code>const_reverse_iterator1</code> pointing to the |
---|
536 | beginning of the reversed <code>triangular_adaptor</code>.</td> |
---|
537 | </tr> |
---|
538 | <tr> |
---|
539 | <td><code>const_reverse_iterator1 rend1 () const</code></td> |
---|
540 | <td>Returns a <code>const_reverse_iterator1</code> pointing to the |
---|
541 | end of the reversed <code>triangular_adaptor</code>.</td> |
---|
542 | </tr> |
---|
543 | <tr> |
---|
544 | <td><code>reverse_iterator1 rbegin1 ()</code></td> |
---|
545 | <td>Returns a <code>reverse_iterator1</code> pointing to the |
---|
546 | beginning of the reversed <code>triangular_adaptor</code>.</td> |
---|
547 | </tr> |
---|
548 | <tr> |
---|
549 | <td><code>reverse_iterator1 rend1 ()</code></td> |
---|
550 | <td>Returns a <code>reverse_iterator1</code> pointing to the end of |
---|
551 | the reversed <code>triangular_adaptor</code>.</td> |
---|
552 | </tr> |
---|
553 | <tr> |
---|
554 | <td><code>const_reverse_iterator2 rbegin2 () const</code></td> |
---|
555 | <td>Returns a <code>const_reverse_iterator2</code> pointing to the |
---|
556 | beginning of the reversed <code>triangular_adaptor</code>.</td> |
---|
557 | </tr> |
---|
558 | <tr> |
---|
559 | <td><code>const_reverse_iterator2 rend2 () const</code></td> |
---|
560 | <td>Returns a <code>const_reverse_iterator2</code> pointing to the |
---|
561 | end of the reversed <code>triangular_adaptor</code>.</td> |
---|
562 | </tr> |
---|
563 | <tr> |
---|
564 | <td><code>reverse_iterator2 rbegin2 ()</code></td> |
---|
565 | <td>Returns a <code>reverse_iterator2</code> pointing to the |
---|
566 | beginning of the reversed <code>triangular_adaptor</code>.</td> |
---|
567 | </tr> |
---|
568 | <tr> |
---|
569 | <td><code>reverse_iterator2 rend2 ()</code></td> |
---|
570 | <td>Returns a <code>reverse_iterator2</code> pointing to the end of |
---|
571 | the reversed <code>triangular_adaptor</code>.</td> |
---|
572 | </tr> |
---|
573 | </tbody> |
---|
574 | </table> |
---|
575 | <h4>Notes</h4> |
---|
576 | <p><a name="triangular_adaptor_1" id="triangular_adaptor_1">[1]</a> |
---|
577 | Supported parameters for the type of the triangular adaptor are |
---|
578 | <code>lower</code> , <code>unit_lower</code>, <code>upper</code> |
---|
579 | and <code>unit_upper</code> .</p> |
---|
580 | <hr /> |
---|
581 | <p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br /> |
---|
582 | Permission to copy, use, modify, sell and distribute this document |
---|
583 | is granted provided this copyright notice appears in all copies. |
---|
584 | This document is provided ``as is'' without express or implied |
---|
585 | warranty, and with no claim as to its suitability for any |
---|
586 | purpose.</p> |
---|
587 | </body> |
---|
588 | </html> |
---|