-
Notifications
You must be signed in to change notification settings - Fork 155
/
vector_sparse.hpp
2246 lines (2068 loc) · 82.2 KB
/
vector_sparse.hpp
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
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// Copyright (c) 2000-2002
// Joerg Walter, Mathias Koch
//
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
//
// The authors gratefully acknowledge the support of
// GeNeSys mbH & Co. KG in producing this work.
//
#ifndef _BOOST_UBLAS_VECTOR_SPARSE_
#define _BOOST_UBLAS_VECTOR_SPARSE_
#include <boost/config.hpp>
// In debug mode, MSCV enables iterator debugging, which additional checks are
// executed for consistency. So, when two iterators are compared, it is tested
// that they point to elements of the same container. If the check fails, then
// the program is aborted.
//
// When matrices MVOV are traversed by column and then by row, the previous
// check fails.
//
// MVOV::iterator2 iter2 = mvov.begin2();
// for (; iter2 != mvov.end() ; iter2++) {
// MVOV::iterator1 iter1 = iter2.begin();
// .....
// }
//
// These additional checks in iterators are disabled in this file, but their
// status are restored at the end of file.
// https://msdn.microsoft.com/en-us/library/hh697468.aspx
#ifdef BOOST_MSVC
#define _BACKUP_ITERATOR_DEBUG_LEVEL _ITERATOR_DEBUG_LEVEL
#undef _ITERATOR_DEBUG_LEVEL
#define _ITERATOR_DEBUG_LEVEL 0
#endif
#include <boost/numeric/ublas/storage_sparse.hpp>
#include <boost/numeric/ublas/vector_expression.hpp>
#include <boost/numeric/ublas/detail/vector_assign.hpp>
#if BOOST_UBLAS_TYPE_CHECK
#include <boost/numeric/ublas/vector.hpp>
#endif
// Iterators based on ideas of Jeremy Siek
namespace boost { namespace numeric { namespace ublas {
#ifdef BOOST_UBLAS_STRICT_VECTOR_SPARSE
template<class V>
class sparse_vector_element:
public container_reference<V> {
public:
typedef V vector_type;
typedef typename V::size_type size_type;
typedef typename V::value_type value_type;
typedef const value_type &const_reference;
typedef value_type *pointer;
private:
// Proxied element operations
void get_d () const {
pointer p = (*this) ().find_element (i_);
if (p)
d_ = *p;
else
d_ = value_type/*zero*/();
}
void set (const value_type &s) const {
pointer p = (*this) ().find_element (i_);
if (!p)
(*this) ().insert_element (i_, s);
else
*p = s;
}
public:
// Construction and destruction
sparse_vector_element (vector_type &v, size_type i):
container_reference<vector_type> (v), i_ (i) {
}
BOOST_UBLAS_INLINE
sparse_vector_element (const sparse_vector_element &p):
container_reference<vector_type> (p), i_ (p.i_) {}
BOOST_UBLAS_INLINE
~sparse_vector_element () {
}
// Assignment
BOOST_UBLAS_INLINE
sparse_vector_element &operator = (const sparse_vector_element &p) {
// Overide the implict copy assignment
p.get_d ();
set (p.d_);
return *this;
}
template<class D>
BOOST_UBLAS_INLINE
sparse_vector_element &operator = (const D &d) {
set (d);
return *this;
}
template<class D>
BOOST_UBLAS_INLINE
sparse_vector_element &operator += (const D &d) {
get_d ();
d_ += d;
set (d_);
return *this;
}
template<class D>
BOOST_UBLAS_INLINE
sparse_vector_element &operator -= (const D &d) {
get_d ();
d_ -= d;
set (d_);
return *this;
}
template<class D>
BOOST_UBLAS_INLINE
sparse_vector_element &operator *= (const D &d) {
get_d ();
d_ *= d;
set (d_);
return *this;
}
template<class D>
BOOST_UBLAS_INLINE
sparse_vector_element &operator /= (const D &d) {
get_d ();
d_ /= d;
set (d_);
return *this;
}
// Comparison
template<class D>
BOOST_UBLAS_INLINE
bool operator == (const D &d) const {
get_d ();
return d_ == d;
}
template<class D>
BOOST_UBLAS_INLINE
bool operator != (const D &d) const {
get_d ();
return d_ != d;
}
// Conversion - weak link in proxy as d_ is not a perfect alias for the element
BOOST_UBLAS_INLINE
operator const_reference () const {
get_d ();
return d_;
}
// Conversion to reference - may be invalidated
BOOST_UBLAS_INLINE
value_type& ref () const {
const pointer p = (*this) ().find_element (i_);
if (!p)
return (*this) ().insert_element (i_, value_type/*zero*/());
else
return *p;
}
private:
size_type i_;
mutable value_type d_;
};
/*
* Generalise explicit reference access
*/
namespace detail {
template <class R>
struct element_reference {
typedef R& reference;
static reference get_reference (reference r)
{
return r;
}
};
template <class V>
struct element_reference<sparse_vector_element<V> > {
typedef typename V::value_type& reference;
static reference get_reference (const sparse_vector_element<V>& sve)
{
return sve.ref ();
}
};
}
template <class VER>
typename detail::element_reference<VER>::reference ref (VER& ver) {
return detail::element_reference<VER>::get_reference (ver);
}
template <class VER>
typename detail::element_reference<VER>::reference ref (const VER& ver) {
return detail::element_reference<VER>::get_reference (ver);
}
template<class V>
struct type_traits<sparse_vector_element<V> > {
typedef typename V::value_type element_type;
typedef type_traits<sparse_vector_element<V> > self_type;
typedef typename type_traits<element_type>::value_type value_type;
typedef typename type_traits<element_type>::const_reference const_reference;
typedef sparse_vector_element<V> reference;
typedef typename type_traits<element_type>::real_type real_type;
typedef typename type_traits<element_type>::precision_type precision_type;
static const unsigned plus_complexity = type_traits<element_type>::plus_complexity;
static const unsigned multiplies_complexity = type_traits<element_type>::multiplies_complexity;
static
BOOST_UBLAS_INLINE
real_type real (const_reference t) {
return type_traits<element_type>::real (t);
}
static
BOOST_UBLAS_INLINE
real_type imag (const_reference t) {
return type_traits<element_type>::imag (t);
}
static
BOOST_UBLAS_INLINE
value_type conj (const_reference t) {
return type_traits<element_type>::conj (t);
}
static
BOOST_UBLAS_INLINE
real_type type_abs (const_reference t) {
return type_traits<element_type>::type_abs (t);
}
static
BOOST_UBLAS_INLINE
value_type type_sqrt (const_reference t) {
return type_traits<element_type>::type_sqrt (t);
}
static
BOOST_UBLAS_INLINE
real_type norm_1 (const_reference t) {
return type_traits<element_type>::norm_1 (t);
}
static
BOOST_UBLAS_INLINE
real_type norm_2 (const_reference t) {
return type_traits<element_type>::norm_2 (t);
}
static
BOOST_UBLAS_INLINE
real_type norm_inf (const_reference t) {
return type_traits<element_type>::norm_inf (t);
}
static
BOOST_UBLAS_INLINE
bool equals (const_reference t1, const_reference t2) {
return type_traits<element_type>::equals (t1, t2);
}
};
template<class V1, class T2>
struct promote_traits<sparse_vector_element<V1>, T2> {
typedef typename promote_traits<typename sparse_vector_element<V1>::value_type, T2>::promote_type promote_type;
};
template<class T1, class V2>
struct promote_traits<T1, sparse_vector_element<V2> > {
typedef typename promote_traits<T1, typename sparse_vector_element<V2>::value_type>::promote_type promote_type;
};
template<class V1, class V2>
struct promote_traits<sparse_vector_element<V1>, sparse_vector_element<V2> > {
typedef typename promote_traits<typename sparse_vector_element<V1>::value_type,
typename sparse_vector_element<V2>::value_type>::promote_type promote_type;
};
#endif
/** \brief Index map based sparse vector
*
* A sparse vector of values of type T of variable size. The sparse storage type A can be
* \c std::map<size_t, T> or \c map_array<size_t, T>. This means that only non-zero elements
* are effectively stored.
*
* For a \f$n\f$-dimensional sparse vector, and 0 <= i < n the non-zero elements \f$v_i\f$
* are mapped to consecutive elements of the associative container, i.e. for elements
* \f$k = v_{i_1}\f$ and \f$k + 1 = v_{i_2}\f$ of the container, holds \f$i_1 < i_2\f$.
*
* Supported parameters for the adapted array are \c map_array<std::size_t, T> and
* \c map_std<std::size_t, T>. The latter is equivalent to \c std::map<std::size_t, T>.
*
* \tparam T the type of object stored in the vector (like double, float, complex, etc...)
* \tparam A the type of Storage array
*/
template<class T, class A>
class mapped_vector:
public vector_container<mapped_vector<T, A> > {
typedef T &true_reference;
typedef T *pointer;
typedef const T *const_pointer;
typedef mapped_vector<T, A> self_type;
public:
#ifdef BOOST_UBLAS_ENABLE_PROXY_SHORTCUTS
using vector_container<self_type>::operator ();
#endif
typedef typename A::size_type size_type;
typedef typename A::difference_type difference_type;
typedef T value_type;
typedef A array_type;
typedef const value_type &const_reference;
#ifndef BOOST_UBLAS_STRICT_VECTOR_SPARSE
typedef typename detail::map_traits<A,T>::reference reference;
#else
typedef sparse_vector_element<self_type> reference;
#endif
typedef const vector_reference<const self_type> const_closure_type;
typedef vector_reference<self_type> closure_type;
typedef self_type vector_temporary_type;
typedef sparse_tag storage_category;
// Construction and destruction
BOOST_UBLAS_INLINE
mapped_vector ():
vector_container<self_type> (),
size_ (0), data_ () {}
BOOST_UBLAS_INLINE
mapped_vector (size_type size, size_type non_zeros = 0):
vector_container<self_type> (),
size_ (size), data_ () {
detail::map_reserve (data(), restrict_capacity (non_zeros));
}
BOOST_UBLAS_INLINE
mapped_vector (const mapped_vector &v):
vector_container<self_type> (),
size_ (v.size_), data_ (v.data_) {}
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector (const vector_expression<AE> &ae, size_type non_zeros = 0):
vector_container<self_type> (),
size_ (ae ().size ()), data_ () {
detail::map_reserve (data(), restrict_capacity (non_zeros));
vector_assign<scalar_assign> (*this, ae);
}
// Accessors
BOOST_UBLAS_INLINE
size_type size () const {
return size_;
}
BOOST_UBLAS_INLINE
size_type nnz_capacity () const {
return detail::map_capacity (data ());
}
BOOST_UBLAS_INLINE
size_type nnz () const {
return data (). size ();
}
// Storage accessors
BOOST_UBLAS_INLINE
const array_type &data () const {
return data_;
}
BOOST_UBLAS_INLINE
array_type &data () {
return data_;
}
// Resizing
private:
BOOST_UBLAS_INLINE
size_type restrict_capacity (size_type non_zeros) const {
non_zeros = (std::min) (non_zeros, size_);
return non_zeros;
}
public:
BOOST_UBLAS_INLINE
void resize (size_type size, bool preserve = true) {
size_ = size;
if (preserve) {
data ().erase (data ().lower_bound(size_), data ().end());
}
else {
data ().clear ();
}
}
// Reserving
BOOST_UBLAS_INLINE
void reserve (size_type non_zeros, bool /*preserve*/ = true) {
detail::map_reserve (data (), restrict_capacity (non_zeros));
}
// Element support
BOOST_UBLAS_INLINE
pointer find_element (size_type i) {
return const_cast<pointer> (const_cast<const self_type&>(*this).find_element (i));
}
BOOST_UBLAS_INLINE
const_pointer find_element (size_type i) const {
const_subiterator_type it (data ().find (i));
if (it == data ().end ())
return 0;
BOOST_UBLAS_CHECK ((*it).first == i, internal_logic ()); // broken map
return &(*it).second;
}
// Element access
BOOST_UBLAS_INLINE
const_reference operator () (size_type i) const {
BOOST_UBLAS_CHECK (i < size_, bad_index ());
const_subiterator_type it (data ().find (i));
if (it == data ().end ())
return zero_;
BOOST_UBLAS_CHECK ((*it).first == i, internal_logic ()); // broken map
return (*it).second;
}
BOOST_UBLAS_INLINE
true_reference ref (size_type i) {
BOOST_UBLAS_CHECK (i < size_, bad_index ());
std::pair<subiterator_type, bool> ii (data ().insert (typename array_type::value_type (i, value_type/*zero*/())));
BOOST_UBLAS_CHECK ((ii.first)->first == i, internal_logic ()); // broken map
return (ii.first)->second;
}
BOOST_UBLAS_INLINE
reference operator () (size_type i) {
#ifndef BOOST_UBLAS_STRICT_VECTOR_SPARSE
return ref (i);
#else
BOOST_UBLAS_CHECK (i < size_, bad_index ());
return reference (*this, i);
#endif
}
BOOST_UBLAS_INLINE
const_reference operator [] (size_type i) const {
return (*this) (i);
}
BOOST_UBLAS_INLINE
reference operator [] (size_type i) {
return (*this) (i);
}
// Element assignment
BOOST_UBLAS_INLINE
true_reference insert_element (size_type i, const_reference t) {
std::pair<subiterator_type, bool> ii = data ().insert (typename array_type::value_type (i, t));
BOOST_UBLAS_CHECK (ii.second, bad_index ()); // duplicate element
BOOST_UBLAS_CHECK ((ii.first)->first == i, internal_logic ()); // broken map
if (!ii.second) // existing element
(ii.first)->second = t;
return (ii.first)->second;
}
BOOST_UBLAS_INLINE
void erase_element (size_type i) {
subiterator_type it = data ().find (i);
if (it == data ().end ())
return;
data ().erase (it);
}
// Zeroing
BOOST_UBLAS_INLINE
void clear () {
data ().clear ();
}
// Assignment
BOOST_UBLAS_INLINE
mapped_vector &operator = (const mapped_vector &v) {
if (this != &v) {
size_ = v.size_;
data () = v.data ();
}
return *this;
}
template<class C> // Container assignment without temporary
BOOST_UBLAS_INLINE
mapped_vector &operator = (const vector_container<C> &v) {
resize (v ().size (), false);
assign (v);
return *this;
}
BOOST_UBLAS_INLINE
mapped_vector &assign_temporary (mapped_vector &v) {
swap (v);
return *this;
}
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector &operator = (const vector_expression<AE> &ae) {
self_type temporary (ae, detail::map_capacity (data()));
return assign_temporary (temporary);
}
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector &assign (const vector_expression<AE> &ae) {
vector_assign<scalar_assign> (*this, ae);
return *this;
}
// Computed assignment
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector &operator += (const vector_expression<AE> &ae) {
self_type temporary (*this + ae, detail::map_capacity (data()));
return assign_temporary (temporary);
}
template<class C> // Container assignment without temporary
BOOST_UBLAS_INLINE
mapped_vector &operator += (const vector_container<C> &v) {
plus_assign (v);
return *this;
}
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector &plus_assign (const vector_expression<AE> &ae) {
vector_assign<scalar_plus_assign> (*this, ae);
return *this;
}
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector &operator -= (const vector_expression<AE> &ae) {
self_type temporary (*this - ae, detail::map_capacity (data()));
return assign_temporary (temporary);
}
template<class C> // Container assignment without temporary
BOOST_UBLAS_INLINE
mapped_vector &operator -= (const vector_container<C> &v) {
minus_assign (v);
return *this;
}
template<class AE>
BOOST_UBLAS_INLINE
mapped_vector &minus_assign (const vector_expression<AE> &ae) {
vector_assign<scalar_minus_assign> (*this, ae);
return *this;
}
template<class AT>
BOOST_UBLAS_INLINE
mapped_vector &operator *= (const AT &at) {
vector_assign_scalar<scalar_multiplies_assign> (*this, at);
return *this;
}
template<class AT>
BOOST_UBLAS_INLINE
mapped_vector &operator /= (const AT &at) {
vector_assign_scalar<scalar_divides_assign> (*this, at);
return *this;
}
// Swapping
BOOST_UBLAS_INLINE
void swap (mapped_vector &v) {
if (this != &v) {
std::swap (size_, v.size_);
data ().swap (v.data ());
}
}
BOOST_UBLAS_INLINE
friend void swap (mapped_vector &v1, mapped_vector &v2) {
v1.swap (v2);
}
// Iterator types
private:
// Use storage iterator
typedef typename A::const_iterator const_subiterator_type;
typedef typename A::iterator subiterator_type;
BOOST_UBLAS_INLINE
true_reference at_element (size_type i) {
BOOST_UBLAS_CHECK (i < size_, bad_index ());
subiterator_type it (data ().find (i));
BOOST_UBLAS_CHECK (it != data ().end(), bad_index ());
BOOST_UBLAS_CHECK ((*it).first == i, internal_logic ()); // broken map
return it->second;
}
public:
class const_iterator;
class iterator;
// Element lookup
// BOOST_UBLAS_INLINE This function seems to be big. So we do not let the compiler inline it.
const_iterator find (size_type i) const {
return const_iterator (*this, data ().lower_bound (i));
}
// BOOST_UBLAS_INLINE This function seems to be big. So we do not let the compiler inline it.
iterator find (size_type i) {
return iterator (*this, data ().lower_bound (i));
}
class const_iterator:
public container_const_reference<mapped_vector>,
public bidirectional_iterator_base<sparse_bidirectional_iterator_tag,
const_iterator, value_type> {
public:
typedef typename mapped_vector::value_type value_type;
typedef typename mapped_vector::difference_type difference_type;
typedef typename mapped_vector::const_reference reference;
typedef const typename mapped_vector::pointer pointer;
// Construction and destruction
BOOST_UBLAS_INLINE
const_iterator ():
container_const_reference<self_type> (), it_ () {}
BOOST_UBLAS_INLINE
const_iterator (const self_type &v, const const_subiterator_type &it):
container_const_reference<self_type> (v), it_ (it) {}
BOOST_UBLAS_INLINE
const_iterator (const typename self_type::iterator &it): // ISSUE self_type:: stops VC8 using std::iterator here
container_const_reference<self_type> (it ()), it_ (it.it_) {}
// Arithmetic
BOOST_UBLAS_INLINE
const_iterator &operator ++ () {
++ it_;
return *this;
}
BOOST_UBLAS_INLINE
const_iterator &operator -- () {
-- it_;
return *this;
}
// Dereference
BOOST_UBLAS_INLINE
const_reference operator * () const {
BOOST_UBLAS_CHECK (index () < (*this) ().size (), bad_index ());
return (*it_).second;
}
// Index
BOOST_UBLAS_INLINE
size_type index () const {
BOOST_UBLAS_CHECK (*this != (*this) ().end (), bad_index ());
BOOST_UBLAS_CHECK ((*it_).first < (*this) ().size (), bad_index ());
return (*it_).first;
}
// Assignment
BOOST_UBLAS_INLINE
const_iterator &operator = (const const_iterator &it) {
container_const_reference<self_type>::assign (&it ());
it_ = it.it_;
return *this;
}
// Comparison
BOOST_UBLAS_INLINE
bool operator == (const const_iterator &it) const {
BOOST_UBLAS_CHECK (&(*this) () == &it (), external_logic ());
return it_ == it.it_;
}
private:
const_subiterator_type it_;
};
BOOST_UBLAS_INLINE
const_iterator begin () const {
return const_iterator (*this, data ().begin ());
}
BOOST_UBLAS_INLINE
const_iterator cbegin () const {
return begin ();
}
BOOST_UBLAS_INLINE
const_iterator end () const {
return const_iterator (*this, data ().end ());
}
BOOST_UBLAS_INLINE
const_iterator cend () const {
return end ();
}
class iterator:
public container_reference<mapped_vector>,
public bidirectional_iterator_base<sparse_bidirectional_iterator_tag,
iterator, value_type> {
public:
typedef typename mapped_vector::value_type value_type;
typedef typename mapped_vector::difference_type difference_type;
typedef typename mapped_vector::true_reference reference;
typedef typename mapped_vector::pointer pointer;
// Construction and destruction
BOOST_UBLAS_INLINE
iterator ():
container_reference<self_type> (), it_ () {}
BOOST_UBLAS_INLINE
iterator (self_type &v, const subiterator_type &it):
container_reference<self_type> (v), it_ (it) {}
// Arithmetic
BOOST_UBLAS_INLINE
iterator &operator ++ () {
++ it_;
return *this;
}
BOOST_UBLAS_INLINE
iterator &operator -- () {
-- it_;
return *this;
}
// Dereference
BOOST_UBLAS_INLINE
reference operator * () const {
BOOST_UBLAS_CHECK (index () < (*this) ().size (), bad_index ());
return (*it_).second;
}
// Index
BOOST_UBLAS_INLINE
size_type index () const {
BOOST_UBLAS_CHECK (*this != (*this) ().end (), bad_index ());
BOOST_UBLAS_CHECK ((*it_).first < (*this) ().size (), bad_index ());
return (*it_).first;
}
// Assignment
BOOST_UBLAS_INLINE
iterator &operator = (const iterator &it) {
container_reference<self_type>::assign (&it ());
it_ = it.it_;
return *this;
}
// Comparison
BOOST_UBLAS_INLINE
bool operator == (const iterator &it) const {
BOOST_UBLAS_CHECK (&(*this) () == &it (), external_logic ());
return it_ == it.it_;
}
private:
subiterator_type it_;
friend class const_iterator;
};
BOOST_UBLAS_INLINE
iterator begin () {
return iterator (*this, data ().begin ());
}
BOOST_UBLAS_INLINE
iterator end () {
return iterator (*this, data ().end ());
}
// Reverse iterator
typedef reverse_iterator_base<const_iterator> const_reverse_iterator;
typedef reverse_iterator_base<iterator> reverse_iterator;
BOOST_UBLAS_INLINE
const_reverse_iterator rbegin () const {
return const_reverse_iterator (end ());
}
BOOST_UBLAS_INLINE
const_reverse_iterator crbegin () const {
return rbegin ();
}
BOOST_UBLAS_INLINE
const_reverse_iterator rend () const {
return const_reverse_iterator (begin ());
}
BOOST_UBLAS_INLINE
const_reverse_iterator crend () const {
return rend ();
}
BOOST_UBLAS_INLINE
reverse_iterator rbegin () {
return reverse_iterator (end ());
}
BOOST_UBLAS_INLINE
reverse_iterator rend () {
return reverse_iterator (begin ());
}
// Serialization
template<class Archive>
void serialize(Archive & ar, const unsigned int /* file_version */){
serialization::collection_size_type s (size_);
ar & serialization::make_nvp("size",s);
if (Archive::is_loading::value) {
size_ = s;
}
ar & serialization::make_nvp("data", data_);
}
private:
size_type size_;
array_type data_;
static const value_type zero_;
};
template<class T, class A>
const typename mapped_vector<T, A>::value_type mapped_vector<T, A>::zero_ = value_type/*zero*/();
// Thanks to Kresimir Fresl for extending this to cover different index bases.
/** \brief Compressed array based sparse vector
*
* a sparse vector of values of type T of variable size. The non zero values are stored as
* two seperate arrays: an index array and a value array. The index array is always sorted
* and there is at most one entry for each index. Inserting an element can be time consuming.
* If the vector contains a few zero entries, then it is better to have a normal vector.
* If the vector has a very high dimension with a few non-zero values, then this vector is
* very memory efficient (at the cost of a few more computations).
*
* For a \f$n\f$-dimensional compressed vector and \f$0 \leq i < n\f$ the non-zero elements
* \f$v_i\f$ are mapped to consecutive elements of the index and value container, i.e. for
* elements \f$k = v_{i_1}\f$ and \f$k + 1 = v_{i_2}\f$ of these containers holds \f$i_1 < i_2\f$.
*
* Supported parameters for the adapted array (indices and values) are \c unbounded_array<> ,
* \c bounded_array<> and \c std::vector<>.
*
* \tparam T the type of object stored in the vector (like double, float, complex, etc...)
* \tparam IB the index base of the compressed vector. Default is 0. Other supported value is 1
* \tparam IA the type of adapted array for indices. Default is \c unbounded_array<std::size_t>
* \tparam TA the type of adapted array for values. Default is unbounded_array<T>
*/
template<class T, std::size_t IB, class IA, class TA>
class compressed_vector:
public vector_container<compressed_vector<T, IB, IA, TA> > {
typedef T &true_reference;
typedef T *pointer;
typedef const T *const_pointer;
typedef compressed_vector<T, IB, IA, TA> self_type;
public:
#ifdef BOOST_UBLAS_ENABLE_PROXY_SHORTCUTS
using vector_container<self_type>::operator ();
#endif
// ISSUE require type consistency check
// is_convertable (IA::size_type, TA::size_type)
typedef typename IA::value_type size_type;
typedef typename IA::difference_type difference_type;
typedef T value_type;
typedef const T &const_reference;
#ifndef BOOST_UBLAS_STRICT_VECTOR_SPARSE
typedef T &reference;
#else
typedef sparse_vector_element<self_type> reference;
#endif
typedef IA index_array_type;
typedef TA value_array_type;
typedef const vector_reference<const self_type> const_closure_type;
typedef vector_reference<self_type> closure_type;
typedef self_type vector_temporary_type;
typedef sparse_tag storage_category;
// Construction and destruction
BOOST_UBLAS_INLINE
compressed_vector ():
vector_container<self_type> (),
size_ (0), capacity_ (restrict_capacity (0)), filled_ (0),
index_data_ (capacity_), value_data_ (capacity_) {
storage_invariants ();
}
explicit BOOST_UBLAS_INLINE
compressed_vector (size_type size, size_type non_zeros = 0):
vector_container<self_type> (),
size_ (size), capacity_ (restrict_capacity (non_zeros)), filled_ (0),
index_data_ (capacity_), value_data_ (capacity_) {
storage_invariants ();
}
BOOST_UBLAS_INLINE
compressed_vector (const compressed_vector &v):
vector_container<self_type> (),
size_ (v.size_), capacity_ (v.capacity_), filled_ (v.filled_),
index_data_ (v.index_data_), value_data_ (v.value_data_) {
storage_invariants ();
}
template<class AE>
BOOST_UBLAS_INLINE
compressed_vector (const vector_expression<AE> &ae, size_type non_zeros = 0):
vector_container<self_type> (),
size_ (ae ().size ()), capacity_ (restrict_capacity (non_zeros)), filled_ (0),
index_data_ (capacity_), value_data_ (capacity_) {
storage_invariants ();
vector_assign<scalar_assign> (*this, ae);
}
// Accessors
BOOST_UBLAS_INLINE
size_type size () const {
return size_;
}
BOOST_UBLAS_INLINE
size_type nnz_capacity () const {
return capacity_;
}
BOOST_UBLAS_INLINE
size_type nnz () const {
return filled_;
}
// Storage accessors
BOOST_UBLAS_INLINE
static size_type index_base () {
return IB;
}
BOOST_UBLAS_INLINE
typename index_array_type::size_type filled () const {
return filled_;
}
BOOST_UBLAS_INLINE
const index_array_type &index_data () const {
return index_data_;
}
BOOST_UBLAS_INLINE
const value_array_type &value_data () const {
return value_data_;
}
BOOST_UBLAS_INLINE
void set_filled (const typename index_array_type::size_type & filled) {
filled_ = filled;
storage_invariants ();
}
BOOST_UBLAS_INLINE
index_array_type &index_data () {
return index_data_;
}
BOOST_UBLAS_INLINE
value_array_type &value_data () {
return value_data_;
}
// Resizing
private:
BOOST_UBLAS_INLINE
size_type restrict_capacity (size_type non_zeros) const {
non_zeros = (std::max) (non_zeros, size_type (1));
non_zeros = (std::min) (non_zeros, size_);
return non_zeros;
}
public:
BOOST_UBLAS_INLINE
void resize (size_type size, bool preserve = true) {
size_ = size;
capacity_ = restrict_capacity (capacity_);
if (preserve) {
index_data_. resize (capacity_, size_type ());
value_data_. resize (capacity_, value_type ());
filled_ = (std::min) (capacity_, filled_);
while ((filled_ > 0) && (zero_based(index_data_[filled_ - 1]) >= size)) {
--filled_;
}
}
else {
index_data_. resize (capacity_);
value_data_. resize (capacity_);
filled_ = 0;
}
storage_invariants ();
}
// Reserving
BOOST_UBLAS_INLINE
void reserve (size_type non_zeros, bool preserve = true) {
capacity_ = restrict_capacity (non_zeros);
if (preserve) {
index_data_. resize (capacity_, size_type ());
value_data_. resize (capacity_, value_type ());
filled_ = (std::min) (capacity_, filled_);
}
else {
index_data_. resize (capacity_);
value_data_. resize (capacity_);
filled_ = 0;
}
storage_invariants ();
}
// Element support
BOOST_UBLAS_INLINE
pointer find_element (size_type i) {
return const_cast<pointer> (const_cast<const self_type&>(*this).find_element (i));
}
BOOST_UBLAS_INLINE
const_pointer find_element (size_type i) const {
const_subiterator_type it (detail::lower_bound (index_data_.begin (), index_data_.begin () + filled_, k_based (i), std::less<size_type> ()));
if (it == index_data_.begin () + filled_ || *it != k_based (i))
return 0;
return &value_data_ [it - index_data_.begin ()];