1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2004), see www.w3.org" />
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<link rel="stylesheet" href="../../../../boost.css" type="text/css"/>
<link rel="stylesheet" href="ublas.css" type="text/css" />
<script type="text/javascript" src="js/jquery-1.3.2.min.js" async="async" ></script>
<script type="text/javascript" src="js/jquery.toc-gw.js" async="async" ></script>
<title>Sparse Matrix</title>
</head>
<body>
<h1><img src="../../../../boost.png" align="middle" />Sparse Matricies</h1>
<div class="toc" id="toc"></div>
<h2><a name="mapped_matrix"></a>Mapped Matrix</h2>
<h4>Description</h4>
<p>The templated class <code>mapped_matrix<T, F, A></code> is
the base container adaptor for sparse matricies using element maps.
For a <em>(m xn</em>)-dimensional sparse matrix and <em>0 <= i < m</em>,
<em>0 <= j < n</em> the non-zero elements
<em>m</em><sub><em>i, j</em></sub> are mapped via <em>(i x n +
j)</em> for row major orientation or via <em>(i + j x m)</em> for
column major orientation to consecutive elements of the associative
container, i.e. for elements <em>k</em> =
<em>m</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub><sub>
<em>,j</em></sub><sub><sub><em>1</em></sub></sub>and <em>k + 1 =
m</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
,j</em></sub><sub><sub><em>2</em></sub></sub>of the container holds
<em>i</em><sub><em>1</em></sub> <em><
i</em><sub><em>2</em></sub> or <em>(i</em><sub><em>1</em></sub>
<em>= i</em><sub><em>2</em></sub> and
<em>j</em><sub><em>1</em></sub> <em><
j</em><sub><em>2</em></sub><em>)</em> with row major orientation or
<em>j</em><sub><em>1</em></sub> <em><
j</em><sub><em>2</em></sub> or <em>(j</em><sub><em>1</em></sub>
<em>= j</em><sub><em>2</em></sub> and
<em>i</em><sub><em>1</em></sub> <em><
i</em><sub><em>2</em></sub><em>)</em> with column major
orientation.</p>
<h4>Example</h4>
<pre>
#include <boost/numeric/ublas/matrix_sparse.hpp>
#include <boost/numeric/ublas/io.hpp>
int main () {
using namespace boost::numeric::ublas;
mapped_matrix<double> m (3, 3, 3 * 3);
for (unsigned i = 0; i < m.size1 (); ++ i)
for (unsigned j = 0; j < m.size2 (); ++ j)
m (i, j) = 3 * i + j;
std::cout << m << std::endl;
}
</pre>
<h4>Definition</h4>
<p>Defined in the header matrix_sparse.hpp.</p>
<h4>Template parameters</h4>
<table border="1" summary="parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>T</code></td>
<td>The type of object stored in the mapped matrix.</td>
<td></td>
</tr>
<tr>
<td><code>F</code></td>
<td>Functor describing the storage organization. <a href=
"#mapped_matrix_1">[1]</a></td>
<td><code>row_major</code></td>
</tr>
<tr>
<td><code>A</code></td>
<td>The type of the adapted array. <a href=
"#mapped_matrix_2">[2]</a></td>
<td><code>map_std<std::size_t, T></code></td>
</tr>
</tbody>
</table>
<h4>Model of</h4>
<p><a href="container_concept.htm#matrix">Matrix</a> .</p>
<h4>Type requirements</h4>
<p>None, except for those imposed by the requirements of <a href=
"container_concept.htm#matrix">Matrix</a> .</p>
<h4>Public base classes</h4>
<p><code>matrix_container<mapped_matrix<T, F, A>
></code></p>
<h4>Members</h4>
<table border="1" summary="members">
<tbody>
<tr>
<th>Member</th>
<th>Description</th>
</tr>
<tr>
<td><code>mapped_matrix ()</code></td>
<td>Allocates a <code>mapped_matrix</code> that holds at most zero
rows of zero elements.</td>
</tr>
<tr>
<td><code>mapped_matrix (size_type size1, size_type2, size_type non_zeros = 0)</code></td>
<td>Allocates a <code>mapped_matrix</code> that holds at most
<code>size1</code> rows of <code>size2</code> elements.</td>
</tr>
<tr>
<td><code>mapped_matrix (const mapped_matrix &m)</code></td>
<td>The copy constructor.</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix (size_type non_zeros, const
matrix_expression<AE> &ae)</code></td>
<td>The extended copy constructor.</td>
</tr>
<tr>
<td><code>void resize (size_type size1, size_type size2, bool preserve = true)</code></td>
<td>Reallocates a <code>mapped_matrix</code> to hold at most
<code>size1</code> rows of <code>size2</code> elements. The
existing elements of the <code>mapped_matrix</code> are preseved
when specified.</td>
</tr>
<tr>
<td><code>size_type size1 () const</code></td>
<td>Returns the number of rows.</td>
</tr>
<tr>
<td><code>size_type size2 () const</code></td>
<td>Returns the number of columns.</td>
</tr>
<tr>
<td><code>const_reference operator () (size_type i, size_type j)
const</code></td>
<td>Returns the value of the <code>j</code>-th element in the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>reference operator () (size_type i, size_type
j)</code></td>
<td>Returns a reference of the <code>j</code>-th element in the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>mapped_matrix &operator = (const mapped_matrix
&m)</code></td>
<td>The assignment operator.</td>
</tr>
<tr>
<td><code>mapped_matrix &assign_temporary (mapped_matrix
&m)</code></td>
<td>Assigns a temporary. May change the mapped matrix
<code>m</code> .</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix &operator = (const matrix_expression<AE>
&ae)</code></td>
<td>The extended assignment operator.</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix &assign (const matrix_expression<AE>
&ae)</code></td>
<td>Assigns a matrix expression to the mapped matrix. Left and
right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix &operator += (const matrix_expression<AE>
&ae)</code></td>
<td>A computed assignment operator. Adds the matrix expression to
the mapped matrix.</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix &plus_assign (const matrix_expression<AE>
&ae)</code></td>
<td>Adds a matrix expression to the mapped matrix. Left and right
hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix &operator -= (const matrix_expression<AE>
&ae)</code></td>
<td>A computed assignment operator. Subtracts the matrix expression
from the mapped matrix.</td>
</tr>
<tr>
<td><code>template<class AE><br />
mapped_matrix &minus_assign (const matrix_expression<AE>
&ae)</code></td>
<td>Subtracts a matrix expression from the mapped matrix. Left and
right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AT><br />
mapped_matrix &operator *= (const AT &at)</code></td>
<td>A computed assignment operator. Multiplies the mapped matrix
with a scalar.</td>
</tr>
<tr>
<td><code>template<class AT><br />
mapped_matrix &operator /= (const AT &at)</code></td>
<td>A computed assignment operator. Divides the mapped matrix
through a scalar.</td>
</tr>
<tr>
<td><code>void swap (mapped_matrix &m)</code></td>
<td>Swaps the contents of the mapped matrices.</td>
</tr>
<tr>
<td><code>true_refrence insert_element (size_type i, size_type j, const_reference
t)</code></td>
<td>Inserts the value <code>t</code> at the <code>j</code>-th
element of the <code>i</code>-th row. Duplicates elements are not allowed.</td>
</tr>
<tr>
<td><code>void erase_element (size_type i, size_type j)</code></td>
<td>Erases the value at the <code>j</code>-th element of the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>void clear ()</code></td>
<td>Clears the mapped matrix.</td>
</tr>
<tr>
<td><code>const_iterator1 begin1 () const</code></td>
<td>Returns a <code>const_iterator1</code> pointing to the
beginning of the <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator1 end1 () const</code></td>
<td>Returns a <code>const_iterator1</code> pointing to the end of
the <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator1 begin1 ()</code></td>
<td>Returns a <code>iterator1</code> pointing to the beginning of
the <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator1 end1 ()</code></td>
<td>Returns a <code>iterator1</code> pointing to the end of the
<code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator2 begin2 () const</code></td>
<td>Returns a <code>const_iterator2</code> pointing to the
beginning of the <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator2 end2 () const</code></td>
<td>Returns a <code>const_iterator2</code> pointing to the end of
the <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator2 begin2 ()</code></td>
<td>Returns a <code>iterator2</code> pointing to the beginning of
the <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator2 end2 ()</code></td>
<td>Returns a <code>iterator2</code> pointing to the end of the
<code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator1 rbegin1 () const</code></td>
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
beginning of the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator1 rend1 () const</code></td>
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
end of the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator1 rbegin1 ()</code></td>
<td>Returns a <code>reverse_iterator1</code> pointing to the
beginning of the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator1 rend1 ()</code></td>
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator2 rbegin2 () const</code></td>
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
beginning of the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator2 rend2 () const</code></td>
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
end of the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator2 rbegin2 ()</code></td>
<td>Returns a <code>reverse_iterator2</code> pointing to the
beginning of the reversed <code>mapped_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator2 rend2 ()</code></td>
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
the reversed <code>mapped_matrix</code>.</td>
</tr>
</tbody>
</table>
<h4>Notes</h4>
<p><a name="mapped_matrix_1">[1]</a> Supported
parameters for the storage organization are <code>row_major</code>
and <code>column_major</code>.</p>
<p><a name="mapped_matrix_2">[2]</a> Supported
parameters for the adapted array are
<code>map_array<std::size_t, T></code> and
<code>map_std<std::size_t, T></code>. The latter is
equivalent to <code>std::map<std::size_t, T></code>.</p>
<h2><a name="compressed_matrix"></a>Compressed Matrix</h2>
<h4>Description</h4>
<p>The templated class <code>compressed_matrix<T, F, IB, IA,
TA></code> is the base container adaptor for compressed
matrices. For a <em>(m x n</em> )-dimensional compressed matrix and
<em>0 <= i < m</em>, <em>0 <= j < n</em> the non-zero
elements <em>m</em><sub><em>i, j</em></sub> are mapped via <em>(i x
n + j)</em> for row major orientation or via <em>(i + j x m)</em>
for column major orientation to consecutive elements of the index
and value containers, i.e. for elements <em>k</em> =
<em>m</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub><sub>
<em>,j</em></sub><sub><sub><em>1</em></sub></sub>and <em>k + 1 =
m</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
,j</em></sub><sub><sub><em>2</em></sub></sub>of the container holds
<em>i</em><sub><em>1</em></sub> <em><
i</em><sub><em>2</em></sub> or <em>(i</em><sub><em>1</em></sub>
<em>= i</em><sub><em>2</em></sub> and
<em>j</em><sub><em>1</em></sub> <em><
j</em><sub><em>2</em></sub><em>)</em> with row major orientation or
<em>j</em><sub><em>1</em></sub> <em><
j</em><sub><em>2</em></sub> or <em>(j</em><sub><em>1</em></sub>
<em>= j</em><sub><em>2</em></sub> and
<em>i</em><sub><em>1</em></sub> <em><
i</em><sub><em>2</em></sub><em>)</em> with column major
orientation.</p>
<h4>Example</h4>
<pre>
#include <boost/numeric/ublas/matrix_sparse.hpp>
#include <boost/numeric/ublas/io.hpp>
int main () {
using namespace boost::numeric::ublas;
compressed_matrix<double> m (3, 3, 3 * 3);
for (unsigned i = 0; i < m.size1 (); ++ i)
for (unsigned j = 0; j < m.size2 (); ++ j)
m (i, j) = 3 * i + j;
std::cout << m << std::endl;
}
</pre>
<h4>Definition</h4>
<p>Defined in the header matrix_sparse.hpp.</p>
<h4>Template parameters</h4>
<table border="1" summary="parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>T</code></td>
<td>The type of object stored in the compressed matrix.</td>
<td></td>
</tr>
<tr>
<td><code>F</code></td>
<td>Functor describing the storage organization. <a href=
"#compressed_matrix_1">[1]</a></td>
<td><code>row_major</code></td>
</tr>
<tr>
<td><code>IB</code></td>
<td>The index base of the compressed vector. <a href=
"#compressed_matrix_2">[2]</a></td>
<td><code>0</code></td>
</tr>
<tr>
<td><code>IA</code></td>
<td>The type of the adapted array for indices. <a href=
"#compressed_matrix_3">[3]</a></td>
<td><code>unbounded_array<std::size_t></code></td>
</tr>
<tr>
<td><code>TA</code></td>
<td>The type of the adapted array for values. <a href=
"#compressed_matrix_3">[3]</a></td>
<td><code>unbounded_array<T></code></td>
</tr>
</tbody>
</table>
<h4>Model of</h4>
<p><a href="container_concept.htm#matrix">Matrix</a> .</p>
<h4>Type requirements</h4>
<p>None, except for those imposed by the requirements of <a href=
"container_concept.htm#matrix">Matrix</a> .</p>
<h4>Public base classes</h4>
<p><code>matrix_container<compressed_matrix<T, F, IB, IA,
TA> ></code></p>
<h4>Members</h4>
<table border="1" summary="members">
<tbody>
<tr>
<th>Member</th>
<th>Description</th>
</tr>
<tr>
<td><code>compressed_matrix ()</code></td>
<td>Allocates a <code>compressed_matrix</code> that holds at most
zero rows of zero elements.</td>
</tr>
<tr>
<td><code>compressed_matrix (size_type size1, size_type2, size_type non_zeros = 0)</code></td>
<td>Allocates a <code>compressed_matrix</code> that holds at most
<code>size1</code> rows of <code>size2</code> elements.</td>
</tr>
<tr>
<td><code>compressed_matrix (const compressed_matrix
&m)</code></td>
<td>The copy constructor.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix (size_type non_zeros, const
matrix_expression<AE> &ae)</code></td>
<td>The extended copy constructor.</td>
</tr>
<tr>
<td><code>void resize (size_type size1, size_type size2, bool preserve = true)</code></td>
<td>Reallocates a <code>compressed_matrix</code> to hold at most
<code>size1</code> rows of <code>size2</code> elements. The
existing elements of the <code>compressed_matrix</code> are
preseved when specified.</td>
</tr>
<tr>
<td><code>size_type size1 () const</code></td>
<td>Returns the number of rows.</td>
</tr>
<tr>
<td><code>size_type size2 () const</code></td>
<td>Returns the number of columns.</td>
</tr>
<tr>
<td><code>const_reference operator () (size_type i, size_type j)
const</code></td>
<td>Returns the value of the <code>j</code>-th element in the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>reference operator () (size_type i, size_type
j)</code></td>
<td>Returns a reference of the <code>j</code>-th element in the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>compressed_matrix &operator = (const
compressed_matrix &m)</code></td>
<td>The assignment operator.</td>
</tr>
<tr>
<td><code>compressed_matrix &assign_temporary
(compressed_matrix &m)</code></td>
<td>Assigns a temporary. May change the compressed matrix
<code>m</code>.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix &operator = (const
matrix_expression<AE> &ae)</code></td>
<td>The extended assignment operator.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix &assign (const matrix_expression<AE>
&ae)</code></td>
<td>Assigns a matrix expression to the compressed matrix. Left and
right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix &operator += (const
matrix_expression<AE> &ae)</code></td>
<td>A computed assignment operator. Adds the matrix expression to
the compressed matrix.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix &plus_assign (const
matrix_expression<AE> &ae)</code></td>
<td>Adds a matrix expression to the compressed matrix. Left and
right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix &operator -= (const
matrix_expression<AE> &ae)</code></td>
<td>A computed assignment operator. Subtracts the matrix expression
from the compressed matrix.</td>
</tr>
<tr>
<td><code>template<class AE><br />
compressed_matrix &minus_assign (const
matrix_expression<AE> &ae)</code></td>
<td>Subtracts a matrix expression from the compressed matrix. Left
and right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AT><br />
compressed_matrix &operator *= (const AT &at)</code></td>
<td>A computed assignment operator. Multiplies the compressed
matrix with a scalar.</td>
</tr>
<tr>
<td><code>template<class AT><br />
compressed_matrix &operator /= (const AT &at)</code></td>
<td>A computed assignment operator. Divides the compressed matrix
through a scalar.</td>
</tr>
<tr>
<td><code>void swap (compressed_matrix &m)</code></td>
<td>Swaps the contents of the compressed matrices.</td>
</tr>
<tr>
<td><code>true_reference insert_element (size_type i, size_type j, const_reference
t)</code></td>
<td>Inserts the value <code>t</code> at the <code>j</code>-th
element of the <code>i</code>-th row. Duplicates elements are not allowed.</td>
</tr>
<tr>
<td><code>void erase_element (size_type i, size_type j)</code></td>
<td>Erases the value at the <code>j</code>-th element of the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>void clear ()</code></td>
<td>Clears the compressed matrix.</td>
</tr>
<tr>
<td><code>const_iterator1 begin1 () const</code></td>
<td>Returns a <code>const_iterator1</code> pointing to the
beginning of the <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator1 end1 () const</code></td>
<td>Returns a <code>const_iterator1</code> pointing to the end of
the <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator1 begin1 ()</code></td>
<td>Returns a <code>iterator1</code> pointing to the beginning of
the <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator1 end1 ()</code></td>
<td>Returns a <code>iterator1</code> pointing to the end of the
<code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator2 begin2 () const</code></td>
<td>Returns a <code>const_iterator2</code> pointing to the
beginning of the <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator2 end2 () const</code></td>
<td>Returns a <code>const_iterator2</code> pointing to the end of
the <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator2 begin2 ()</code></td>
<td>Returns a <code>iterator2</code> pointing to the beginning of
the <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator2 end2 ()</code></td>
<td>Returns a <code>iterator2</code> pointing to the end of the
<code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator1 rbegin1 () const</code></td>
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
beginning of the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator1 rend1 () const</code></td>
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
end of the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator1 rbegin1 ()</code></td>
<td>Returns a <code>reverse_iterator1</code> pointing to the
beginning of the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator1 rend1 ()</code></td>
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator2 rbegin2 () const</code></td>
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
beginning of the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator2 rend2 () const</code></td>
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
end of the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator2 rbegin2 ()</code></td>
<td>Returns a <code>reverse_iterator2</code> pointing to the
beginning of the reversed <code>compressed_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator2 rend2 ()</code></td>
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
the reversed <code>compressed_matrix</code>.</td>
</tr>
</tbody>
</table>
<h4>Notes</h4>
<p><a name="compressed_matrix_1">[1]</a>
Supported parameters for the storage organization are
<code>row_major</code> and <code>column_major</code>.</p>
<p><a name="compressed_matrix_2">[2]</a>
Supported parameters for the index base are <code>0</code> and
<code>1</code> at least.</p>
<p><a name="compressed_matrix_3">[3]</a>
Supported parameters for the adapted array are
<code>unbounded_array<></code> ,
<code>bounded_array<></code> and
<code>std::vector<></code> .</p>
<h2><a name="coordinate_matrix"></a>Coordinate Matrix</h2>
<h4>Description</h4>
<p>The templated class <code>coordinate_matrix<T, F, IB, IA,
TA></code> is the base container adaptor for compressed
matrices. For a <em>(m x n</em> )-dimensional sorted coordinate
matrix and <em>0 <= i < m</em>, <em>0 <= j < n</em> the
non-zero elements <em>m</em><sub><em>i, j</em></sub> are mapped via
<em>(i x n + j)</em> for row major orientation or via <em>(i + j x
m)</em> for column major orientation to consecutive elements of the
index and value containers, i.e. for elements <em>k</em> =
<em>m</em><sub><em>i</em></sub><sub><sub><em>1</em></sub></sub><sub>
<em>,j</em></sub><sub><sub><em>1</em></sub></sub>and <em>k + 1 =
m</em><sub><em>i</em></sub><sub><sub><em>2</em></sub></sub><sub><em>
,j</em></sub><sub><sub><em>2</em></sub></sub>of the container holds
<em>i</em><sub><em>1</em></sub> <em><
i</em><sub><em>2</em></sub> or <em>(i</em><sub><em>1</em></sub>
<em>= i</em><sub><em>2</em></sub> and
<em>j</em><sub><em>1</em></sub> <em><
j</em><sub><em>2</em></sub><em>)</em> with row major orientation or
<em>j</em><sub><em>1</em></sub> <em><
j</em><sub><em>2</em></sub> or <em>(j</em><sub><em>1</em></sub>
<em>= j</em><sub><em>2</em></sub> and
<em>i</em><sub><em>1</em></sub> <em><
i</em><sub><em>2</em></sub><em>)</em> with column major
orientation.</p>
<h4>Example</h4>
<pre>
#include <boost/numeric/ublas/matrix_sparse.hpp>
#include <boost/numeric/ublas/io.hpp>
int main () {
using namespace boost::numeric::ublas;
coordinate_matrix<double> m (3, 3, 3 * 3);
for (unsigned i = 0; i < m.size1 (); ++ i)
for (unsigned j = 0; j < m.size2 (); ++ j)
m (i, j) = 3 * i + j;
std::cout << m << std::endl;
}
</pre>
<h4>Definition</h4>
<p>Defined in the header matrix_sparse.hpp.</p>
<h4>Template parameters</h4>
<table border="1" summary="parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>T</code></td>
<td>The type of object stored in the coordinate matrix.</td>
<td></td>
</tr>
<tr>
<td><code>F</code></td>
<td>Functor describing the storage organization. <a href=
"#coordinate_matrix_1">[1]</a></td>
<td><code>row_major</code></td>
</tr>
<tr>
<td><code>IB</code></td>
<td>The index base of the coordinate vector. <a href=
"#coordinate_matrix_2">[2]</a></td>
<td><code>0</code></td>
</tr>
<tr>
<td><code>IA</code></td>
<td>The type of the adapted array for indices. <a href=
"#coordinate_matrix_3">[3]</a></td>
<td><code>unbounded_array<std::size_t></code></td>
</tr>
<tr>
<td><code>TA</code></td>
<td>The type of the adapted array for values. <a href=
"#coordinate_matrix_3">[3]</a></td>
<td><code>unbounded_array<T></code></td>
</tr>
</tbody>
</table>
<h4>Model of</h4>
<p><a href="container_concept.htm#matrix">Matrix</a> .</p>
<h4>Type requirements</h4>
<p>None, except for those imposed by the requirements of <a href=
"container_concept.htm#matrix">Matrix</a> .</p>
<h4>Public base classes</h4>
<p><code>matrix_container<coordinate_matrix<T, F, IB, IA,
TA> ></code></p>
<h4>Members</h4>
<table border="1" summary="members">
<tbody>
<tr>
<th>Member</th>
<th>Description</th>
</tr>
<tr>
<td><code>coordinate_matrix ()</code></td>
<td>Allocates a <code>coordinate_matrix</code> that holds at most
zero rows of zero elements.</td>
</tr>
<tr>
<td><code>coordinate_matrix (size_type size1, size_type2, size_type non_zeros = 0)</code></td>
<td>Allocates a <code>coordinate_matrix</code> that holds at most
<code>size1</code> rows of <code>size2</code> elements.</td>
</tr>
<tr>
<td><code>coordinate_matrix (const coordinate_matrix
&m)</code></td>
<td>The copy constructor.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix (size_type non_zeros, const
matrix_expression<AE> &ae)</code></td>
<td>The extended copy constructor.</td>
</tr>
<tr>
<td><code>void resize (size_type size1, size_type size2, bool preserve = true)</code></td>
<td>Reallocates a <code>coordinate_matrix</code> to hold at most
<code>size1</code> rows of <code>size2</code> elements. The
existing elements of the <code>coordinate_matrix</code> are
preseved when specified.</td>
</tr>
<tr>
<td><code>size_type size1 () const</code></td>
<td>Returns the number of rows.</td>
</tr>
<tr>
<td><code>size_type size2 () const</code></td>
<td>Returns the number of columns.</td>
</tr>
<tr>
<td><code>const_reference operator () (size_type i, size_type j)
const</code></td>
<td>Returns the value of the <code>j</code>-th element in the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>reference operator () (size_type i, size_type
j)</code></td>
<td>Returns a reference of the <code>j</code>-th element in the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>coordinate_matrix &operator = (const
coordinate_matrix &m)</code></td>
<td>The assignment operator.</td>
</tr>
<tr>
<td><code>coordinate_matrix &assign_temporary
(coordinate_matrix &m)</code></td>
<td>Assigns a temporary. May change the coordinate matrix
<code>m</code>.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix &operator = (const
matrix_expression<AE> &ae)</code></td>
<td>The extended assignment operator.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix &assign (const matrix_expression<AE>
&ae)</code></td>
<td>Assigns a matrix expression to the coordinate matrix. Left and
right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix &operator += (const
matrix_expression<AE> &ae)</code></td>
<td>A computed assignment operator. Adds the matrix expression to
the coordinate matrix.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix &plus_assign (const
matrix_expression<AE> &ae)</code></td>
<td>Adds a matrix expression to the coordinate matrix. Left and
right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix &operator -= (const
matrix_expression<AE> &ae)</code></td>
<td>A computed assignment operator. Subtracts the matrix expression
from the coordinate matrix.</td>
</tr>
<tr>
<td><code>template<class AE><br />
coordinate_matrix &minus_assign (const
matrix_expression<AE> &ae)</code></td>
<td>Subtracts a matrix expression from the coordinate matrix. Left
and right hand side of the assignment should be independent.</td>
</tr>
<tr>
<td><code>template<class AT><br />
coordinate_matrix &operator *= (const AT &at)</code></td>
<td>A computed assignment operator. Multiplies the coordinate
matrix with a scalar.</td>
</tr>
<tr>
<td><code>template<class AT><br />
coordinate_matrix &operator /= (const AT &at)</code></td>
<td>A computed assignment operator. Divides the coordinate matrix
through a scalar.</td>
</tr>
<tr>
<td><code>void swap (coordinate_matrix &m)</code></td>
<td>Swaps the contents of the coordinate matrices.</td>
</tr>
<tr>
<td><code>true_reference insert_element (size_type i, size_type j, const_reference
t)</code></td>
<td>Inserts the value <code>t</code> at the <code>j</code>-th
element of the <code>i</code>-th row. Duplicates elements are not allowed.</td>
</tr>
<tr>
<td><code>void append_element (size_type i, size_type j, const_reference t)</code></td>
<td>Appends the value <code>t</code> at the <code>j</code>-th element of the <code>i</code>-th row.
Duplicate elements can be appended to a <code>coordinate_matrix</code>. They are merged into a single
arithmetically summed element by the <code>sort</code> function.</td>
</tr>
<tr>
<td><code>void erase_element (size_type i, size_type j)</code></td>
<td>Erases the value at the <code>j</code>-th element of the
<code>i</code>-th row.</td>
</tr>
<tr>
<td><code>void clear ()</code></td>
<td>Clears the coordinate matrix.</td>
</tr>
<tr>
<td><code>const_iterator1 begin1 () const</code></td>
<td>Returns a <code>const_iterator1</code> pointing to the
beginning of the <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator1 end1 () const</code></td>
<td>Returns a <code>const_iterator1</code> pointing to the end of
the <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator1 begin1 ()</code></td>
<td>Returns a <code>iterator1</code> pointing to the beginning of
the <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator1 end1 ()</code></td>
<td>Returns a <code>iterator1</code> pointing to the end of the
<code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator2 begin2 () const</code></td>
<td>Returns a <code>const_iterator2</code> pointing to the
beginning of the <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_iterator2 end2 () const</code></td>
<td>Returns a <code>const_iterator2</code> pointing to the end of
the <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator2 begin2 ()</code></td>
<td>Returns a <code>iterator2</code> pointing to the beginning of
the <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>iterator2 end2 ()</code></td>
<td>Returns a <code>iterator2</code> pointing to the end of the
<code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator1 rbegin1 () const</code></td>
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
beginning of the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator1 rend1 () const</code></td>
<td>Returns a <code>const_reverse_iterator1</code> pointing to the
end of the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator1 rbegin1 ()</code></td>
<td>Returns a <code>reverse_iterator1</code> pointing to the
beginning of the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator1 rend1 ()</code></td>
<td>Returns a <code>reverse_iterator1</code> pointing to the end of
the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator2 rbegin2 () const</code></td>
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
beginning of the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>const_reverse_iterator2 rend2 () const</code></td>
<td>Returns a <code>const_reverse_iterator2</code> pointing to the
end of the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator2 rbegin2 ()</code></td>
<td>Returns a <code>reverse_iterator2</code> pointing to the
beginning of the reversed <code>coordinate_matrix</code>.</td>
</tr>
<tr>
<td><code>reverse_iterator2 rend2 ()</code></td>
<td>Returns a <code>reverse_iterator2</code> pointing to the end of
the reversed <code>coordinate_matrix</code>.</td>
</tr>
</tbody>
</table>
<h4>Notes</h4>
<p><a name="coordinate_matrix_1">[1]</a>
Supported parameters for the storage organization are
<code>row_major</code> and <code>column_major</code>.</p>
<p><a name="coordinate_matrix_2">[2]</a>
Supported parameters for the index base are <code>0</code> and
<code>1</code> at least.</p>
<p><a name="coordinate_matrix_3">[3]</a>
Supported parameters for the adapted array are
<code>unbounded_array<></code> ,
<code>bounded_array<></code> and
<code>std::vector<></code> .</p>
<hr />
<p>Copyright (©) 2000-2002 Joerg Walter, Mathias Koch<br />
Use, modification and distribution are subject to the
Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt
or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
http://www.boost.org/LICENSE_1_0.txt
</a>).
</p>
<script type="text/javascript">
(function($) {
$('#toc').toc();
})(jQuery);
</script>
</body>
</html>
|
