-
Notifications
You must be signed in to change notification settings - Fork 88
Expand file tree
/
Copy patharray.hpp
More file actions
2053 lines (1839 loc) · 56.1 KB
/
Copy patharray.hpp
File metadata and controls
2053 lines (1839 loc) · 56.1 KB
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
/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <[email protected]>
* Guido Tack <[email protected]>
*
* Contributing authors:
* Gregory Crosswhite <[email protected]>
*
* Copyright:
* Gregory Crosswhite, 2011
* Christian Schulte, 2003
* Guido Tack, 2004
*
* This file is part of Gecode, the generic constraint
* development environment:
* http://www.gecode.org
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#include <iostream>
#include <iterator>
#include <vector>
#include <sstream>
#include <initializer_list>
namespace Gecode { namespace Kernel {
/// Occurence information for a view
template<class View>
class ViewOcc {
public:
/// The view
View x;
/// The original index in the array
int i;
/// Sorting order
bool operator <(const ViewOcc& y) const;
};
template<class View>
forceinline bool
ViewOcc<View>::operator <(const ViewOcc& y) const {
return x < y.x;
}
/// Check whether \a p has duplicates among its \a n elements (changes \a p)
GECODE_KERNEL_EXPORT
bool duplicates(void** p, int n);
/// Check whether \a p has common elements with \a q
GECODE_KERNEL_EXPORT
bool duplicates(void** p, int n, void** q, int m);
}}
namespace Gecode {
template<class Var> class VarArray;
template<class Var> class VarArgArray;
/** \brief Traits of arrays in %Gecode
*
* This class collects the traits of an array in Gecode.
* The traits used are the following.
* - <code>typedef Type StorageType</code> where \c Type is the type
* of an appropriate storage type for this array.
* - <code>typedef Type ValueType</code> where \c Type is the type
* of the elements of this array.
* - <code>typedef Type ArgsType</code> where \c Type is the type
* of the appropriate Args-array type (e.g., \c BoolVarArgs if \c A is
* \c BoolVarArray).
*/
template<class A>
class ArrayTraits {};
/**
* \brief %Variable arrays
*
* %Variable arrays store variables. They are typically used
* for storing the variables being part of a solution.
*
* Never use them for temporary purposes, use argument arrays
* instead.
*
* %Variable arrays can be enlarged dynamically. For memory efficiency, the
* initial array is allocated in the space. When adding variables, it is
* automatically resized and allocated on the heap.
*
* \ingroup TaskVar
*/
template<class Var>
class VarArray {
protected:
/// Number of variables (size)
int n;
/// Array of variables
Var* x;
public:
/// \name Associated types
//@{
/// Type of the variable stored in this array
typedef Var value_type;
/// Type of a reference to the value type
typedef Var& reference;
/// Type of a constant reference to the value type
typedef const Var& const_reference;
/// Type of a pointer to the value type
typedef Var* pointer;
/// Type of a read-only pointer to the value type
typedef const Var* const_pointer;
/// Type of the iterator used to iterate through this array's elements
typedef Var* iterator;
/// Type of the iterator used to iterate read-only through this array's elements
typedef const Var* const_iterator;
/// Type of the iterator used to iterate backwards through this array's elements
typedef std::reverse_iterator<Var*> reverse_iterator;
/// Type of the iterator used to iterate backwards and read-only through this array's elements
typedef std::reverse_iterator<const Var*> const_reverse_iterator;
//@}
//@{
/// \name Constructors and initialization
//@{
/// Default constructor (array of size 0)
VarArray(void);
/// Allocate array with \a m variables
VarArray(Space& home, int m);
/// Initialize from variable argument array \a a (copy elements)
VarArray(Space& home, const VarArgArray<Var>&);
/// Initialize from variable array \a a (share elements)
VarArray(const VarArray<Var>& a);
/// Initialize from variable array \a a (share elements)
const VarArray<Var>& operator =(const VarArray<Var>& a);
//@}
/// \name Array size
//@{
/// Return size of array (number of elements)
int size(void) const;
//@}
/// \name Array elements
//@{
/// Return variable at position \a i
Var& operator [](int i);
/// Return variable at position \a i
const Var& operator [](int i) const;
/** Return slice \f$y\f$ of length at most \a n such that forall \f$0\leq i<n\f$, \f$y_i=x_{\text{start}+i\cdot\text{inc}}\f$
*
* If \a n is -1, then all possible elements starting from \a start
* with increment \a inc are returned.
*/
typename ArrayTraits<VarArgArray<Var>>::ArgsType
slice(int start, int inc=1, int n=-1);
//@}
/// \name Array iteration
//@{
/// Return an iterator at the beginning of the array
iterator begin(void);
/// Return a read-only iterator at the beginning of the array
const_iterator begin(void) const;
/// Return an iterator past the end of the array
iterator end(void);
/// Return a read-only iterator past the end of the array
const_iterator end(void) const;
/// Return a reverse iterator at the end of the array
reverse_iterator rbegin(void);
/// Return a reverse and read-only iterator at the end of the array
const_reverse_iterator rbegin(void) const;
/// Return a reverse iterator past the beginning of the array
reverse_iterator rend(void);
/// Return a reverse and read-only iterator past the beginning of the array
const_reverse_iterator rend(void) const;
//@}
/// Test if all variables are assigned
bool assigned(void) const;
/// \name Cloning
//@{
/// Update array to be a clone of array \a a
void update(Space& home, VarArray<Var>& a);
//@}
/// Allocate memory from heap (disabled)
static void* operator new(size_t s) = delete;
/// Free memory allocated from heap (disabled)
static void operator delete(void* p) = delete;
};
/** Concatenate \a x and \a y and return result
* \relates VarArray
*/
template<class T>
typename ArrayTraits<VarArray<T>>::ArgsType
operator +(const VarArray<T>& x, const VarArgArray<T>& y);
/** Concatenate \a x and \a y and return result
* \relates VarArray
*/
template<class T>
typename ArrayTraits<VarArray<T>>::ArgsType
operator +(const VarArray<T>& x, const VarArray<T>& y);
/** Concatenate \a x and \a y and return result
* \relates VarArray
*/
template<class T>
typename ArrayTraits<VarArray<T>>::ArgsType
operator +(const VarArgArray<T>& x, const VarArray<T>& y);
/** Concatenate \a x and \a y and return result
* \relates VarArray
*/
template<class T>
typename ArrayTraits<VarArray<T>>::ArgsType
operator +(const VarArray<T>& x, const T& y);
/** Concatenate \a x and \a y and return result
* \relates VarArray
*/
template<class T>
typename ArrayTraits<VarArray<T>>::ArgsType
operator +(const T& x, const VarArray<T>& y);
/**
* \brief View arrays
*
* View arrays store views. They are typically used for storing the
* views with which propagators and branchers compute.
* \ingroup TaskActor
*/
template<class View>
class ViewArray {
private:
/// Number of views (size)
int n;
/// Views
View* x;
public:
/// \name Associated types
//@{
/// Type of the view stored in this array
typedef View value_type;
/// Type of a reference to the value type
typedef View& reference;
/// Type of a constant reference to the value type
typedef const View& const_reference;
/// Type of a pointer to the value type
typedef View* pointer;
/// Type of a read-only pointer to the value type
typedef const View* const_pointer;
/// Type of the iterator used to iterate through this array's elements
typedef View* iterator;
/// Type of the iterator used to iterate read-only through this array's elements
typedef const View* const_iterator;
/// Type of the iterator used to iterate backwards through this array's elements
typedef std::reverse_iterator<View*> reverse_iterator;
/// Type of the iterator used to iterate backwards and read-only through this array's elements
typedef std::reverse_iterator<const View*> const_reverse_iterator;
//@}
/// \name Constructors and initialization
//@{
/// Default constructor (array of size 0)
ViewArray(void);
/// Allocate array with \a m views
ViewArray(Space& home, int m);
/// Allocate array with \a m views
ViewArray(Region& r, int m);
/// Initialize from view array \a a (share elements)
ViewArray(const ViewArray<View>& a);
/// Initialize from view array \a a (copy elements)
ViewArray(Space& home, const ViewArray<View>& a);
/// Initialize from view array \a a (copy elements)
ViewArray(Region& r, const ViewArray<View>& a);
/// Initialize from view array \a a (share elements)
const ViewArray<View>& operator =(const ViewArray<View>& a);
/**
* \brief Initialize from variable argument array \a a (copy elements)
*
* Note that the view type \a View must provide a constructor
* for the associated \a Var type.
*/
template<class Var>
ViewArray(Space& home, const VarArgArray<Var>& a)
: n(a.size()) {
// This may not be in the hpp file (to satisfy the MS compiler)
if (n>0) {
x = home.alloc<View>(n);
for (int i=0; i<n; i++)
x[i]=a[i];
} else {
x = nullptr;
}
}
/**
* \brief Initialize from variable argument array \a a (copy elements)
*
* Note that the view type \a View must provide a constructor
* for the associated \a Var type.
*/
template<class Var>
ViewArray(Region& r, const VarArgArray<Var>& a)
: n(a.size()) {
// This may not be in the hpp file (to satisfy the MS compiler)
if (n>0) {
x = r.alloc<View>(n);
for (int i=0; i<n; i++)
x[i]=a[i];
} else {
x = nullptr;
}
}
//@}
/// \name Array size
//@{
/// Return size of array (number of elements)
int size(void) const;
/// Decrease size of array (number of elements)
void size(int n);
//@}
/// \name Array elements
//@{
/// Return view at position \a i
View& operator [](int i);
/// Return view at position \a i
const View& operator [](int i) const;
//@}
/// \name Array iteration
//@{
/// Return an iterator at the beginning of the array
iterator begin(void);
/// Return a read-only iterator at the beginning of the array
const_iterator begin(void) const;
/// Return an iterator past the end of the array
iterator end(void);
/// Return a read-only iterator past the end of the array
const_iterator end(void) const;
/// Return a reverse iterator at the end of the array
reverse_iterator rbegin(void);
/// Return a reverse and read-only iterator at the end of the array
const_reverse_iterator rbegin(void) const;
/// Return a reverse iterator past the beginning of the array
reverse_iterator rend(void);
/// Return a reverse and read-only iterator past the beginning of the array
const_reverse_iterator rend(void) const;
//@}
/// \name Dependencies
//@{
/**
* \brief Subscribe propagator \a p with propagation condition \a pc to variable
*
* In case \a process is false, the propagator is just subscribed but
* not scheduled for execution (this must be used when creating
* subscriptions during propagation).
*/
void subscribe(Space& home, Propagator& p, PropCond pc,
bool schedule=true);
/// Cancel subscription of propagator \a p with propagation condition \a pc to all views
void cancel(Space& home, Propagator& p, PropCond pc);
/// Subscribe advisor \a a to variable
void subscribe(Space& home, Advisor& a);
/// Cancel subscription of advisor \a a
void cancel(Space& home, Advisor& a);
/// Re-schedule propagator \a p with propagation condition \a pc
void reschedule(Space& home, Propagator& p, PropCond pc);
//@}
/// \name Cloning
//@{
/// Update array to be a clone of array \a a
void update(Space& home, ViewArray<View>& a);
//@}
/// \name Moving elements
//@{
/// Move view from position 0 to position \a i (shift elements to the left)
void move_fst(int i);
/// Move view from position \c size()-1 to position \a i (truncate array by one)
void move_lst(int i);
/** \brief Move view from position 0 to position \a i (shift elements to the left)
*
* Before moving, cancel subscription of propagator \a p with
* propagation condition \a pc to view at position \a i.
*/
void move_fst(int i, Space& home, Propagator& p, PropCond pc);
/** \brief Move view from position \c size()-1 to position \a i (truncate array by one)
*
* Before moving, cancel subscription of propagator \a p with
* propagation condition \a pc to view at position \a i.
*/
void move_lst(int i, Space& home, Propagator& p, PropCond pc);
/** \brief Move view from position 0 to position \a i (shift elements to the left)
*
* Before moving, cancel subscription of advisor \a a
* to view at position \a i.
*/
void move_fst(int i, Space& home, Advisor& a);
/** \brief Move view from position \c size()-1 to position \a i (truncate array by one)
*
* Before moving, cancel subscription of advisor \a a to view
* at position \a i.
*/
void move_lst(int i, Space& home, Advisor& a);
//@}
/// \name Dropping elements
//@{
/// Drop views from positions 0 to \a i-1 from array
void drop_fst(int i);
/// Drop views from positions \a i+1 to \c size()-1 from array
void drop_lst(int i);
/** \brief Drop views from positions 0 to \a i-1 from array
*
* Before moving, cancel subscription of propagator \a p with
* propagation condition \a pc to views at positions 0 to \a i-1.
*/
void drop_fst(int i, Space& home, Propagator& p, PropCond pc);
/** \brief Drop assigned views from positions \a i+1 to \c size()-1 from array
*
* Before moving, cancel subscription of propagator \a p with
* propagation condition \a pc to views at positions \a i+1 to
* \c size()-1.
*/
void drop_lst(int i, Space& home, Propagator& p, PropCond pc);
/** \brief Drop views from positions 0 to \a i-1 from array
*
* Before moving, cancel subscription of advisor \a a to views at
* positions 0 to \a i-1.
*/
void drop_fst(int i, Space& home, Advisor& a);
/** \brief Drop assigned views from positions \a i+1 to \c size()-1 from array
*
* Before moving, cancel subscription of advisor \a a to views at
* positions \a i+1 to \c size()-1.
*/
void drop_lst(int i, Space& home, Advisor& a);
//@}
/// Test if all variables are assigned
bool assigned(void) const;
/// \name View equality
//@{
/**
* \brief Test whether array has multiple occurence of the same view
*
* Note that assigned views are ignored.
*/
bool same(void) const;
/**
* \brief Test whether array contains a view being the same as \a y
*
* Note that assigned views are ignored.
*/
bool same(const View& y) const;
/// Remove all duplicate views from array (changes element order)
void unique(void);
//@}
/// Allocate memory from heap (disabled)
static void* operator new(size_t s) = delete;
/// Free memory allocated from heap (disabled)
static void operator delete(void* p) = delete;
};
/**
* \brief Test whether array \a x together with array \a y contains shared views
*
* Note that assigned views are ignored.
* \relates ViewArray
*/
template<class ViewX, class ViewY>
bool shared(ViewArray<ViewX> x, ViewArray<ViewY> y);
/**
* \brief Test whether array \a x contains a view shared with \a y
*
* Note that assigned views are ignored.
* \relates ViewArray
*/
template<class ViewX, class ViewY>
bool shared(ViewArray<ViewX> x, ViewY y);
/**
* \brief Test whether array \a y contains a view shared with \a x
*
* Note that assigned views are ignored.
* \relates ViewArray
*/
template<class ViewX, class ViewY>
bool shared(ViewX x, ViewArray<ViewY> y);
/**
* \brief Test whether array \a x contains shared views
*
* Note that assigned views are ignored.
* \relates ViewArray
*/
template<class View>
bool shared(ViewArray<View> x);
/**
* \brief Base-class for argument arrays
*
* Argument arrays are used as convenient mechanism of passing arguments
* when calling functions as they combine both the size and the elements
* of an array. For a small number of elements, memory is allocated by
* creating an argument array object. Otherwise the memory is allocated
* from the heap.
*
* \ingroup TaskVar
*/
template<class T>
class ArgArrayBase {
protected:
/// Number of elements
int n;
/// Allocated size of the array
int capacity;
/// Element array
T* a;
/// How many elements are possible inside array
static const int onstack_size = 16;
/// In-array storage for elements
T onstack[onstack_size];
/// Allocate memory for \a n elements
T* allocate(int n);
/// Resize to hold at least \a i additional elements
void resize(int i);
/// Return this array concatenated with \a x
template<class A>
A concat(const ArgArrayBase<T>& x) const;
/// Return this array concatenated with \a x
template<class A>
A concat(const T& x) const;
/// Insert a new element \a x at the end of the array (increase size by 1)
template<class A>
A& append(const T& x);
/// Append \a x to the end of the array
template<class A>
A& append(const ArgArrayBase<T>& x);
/** Return slice \f$y\f$ of length at most \a n such that forall \f$0\leq i<n\f$, \f$y_i=x_{\text{start}+i\cdot\text{inc}}\f$
*
* If \a n is -1, then all possible elements starting from \a start
* with increment \a inc are returned.
*/
template<class A>
A slice(int start, int inc=1, int n=-1);
public:
/// \name Associated types
//@{
/// Type of the view stored in this array
typedef T value_type;
/// Type of a reference to the value type
typedef T& reference;
/// Type of a constant reference to the value type
typedef const T& const_reference;
/// Type of a pointer to the value type
typedef T* pointer;
/// Type of a read-only pointer to the value type
typedef const T* const_pointer;
/// Type of the iterator used to iterate through this array's elements
typedef T* iterator;
/// Type of the iterator used to iterate read-only through this array's elements
typedef const T* const_iterator;
/// Type of the iterator used to iterate backwards through this array's elements
typedef std::reverse_iterator<T*> reverse_iterator;
/// Type of the iterator used to iterate backwards and read-only through this array's elements
typedef std::reverse_iterator<const T*> const_reverse_iterator;
//@}
/// \name Constructors and initialization
//@{
/// Allocate empty array
ArgArrayBase(void);
/// Allocate array with \a n elements
explicit ArgArrayBase(int n);
/// Initialize from argument array \a a (copy elements)
ArgArrayBase(const ArgArrayBase<T>& a);
/// Initialize from view array \a a (copy elements)
const ArgArrayBase<T>& operator =(const ArgArrayBase<T>& a);
/// Initialize from vector \a a
ArgArrayBase(const std::vector<T>& a);
/// Initialize from initializer list \a a
ArgArrayBase(std::initializer_list<T> a);
/// Initialize from InputIterator \a begin and \a end
template<class InputIterator>
ArgArrayBase(InputIterator first, InputIterator last);
//@}
/// \name Array size
//@{
/// Return size of array (number of elements)
int size(void) const;
//@}
/// \name Array elements
//@{
/// Return element at position \a i
T& operator [](int i);
/// Return element at position \a i
const T& operator [](int i) const;
//@}
/// \name Array iteration
//@{
/// Return an iterator at the beginning of the array
iterator begin(void);
/// Return a read-only iterator at the beginning of the array
const_iterator begin(void) const;
/// Return an iterator past the end of the array
iterator end(void);
/// Return a read-only iterator past the end of the array
const_iterator end(void) const;
/// Return a reverse iterator at the end of the array
reverse_iterator rbegin(void);
/// Return a reverse and read-only iterator at the end of the array
const_reverse_iterator rbegin(void) const;
/// Return a reverse iterator past the beginning of the array
reverse_iterator rend(void);
/// Return a reverse and read-only iterator past the beginning of the array
const_reverse_iterator rend(void) const;
//@}
/// \name Destructor
//@{
/// Destructor
~ArgArrayBase(void);
//@}
};
template<class> class ArgArray;
/** Concatenate \a x and \a y and return result
* \relates ArgArray
*/
template<class T>
typename ArrayTraits<ArgArray<T>>::ArgsType
operator +(const ArgArray<T>& x, const ArgArray<T>& y);
/** Concatenate \a x and \a y and return result
* \relates ArgArray
*/
template<class T>
typename ArrayTraits<ArgArray<T>>::ArgsType
operator +(const ArgArray<T>& x, const T& y);
/** Concatenate \a x and \a y and return result
* \relates ArgArray
*/
template<class T>
typename ArrayTraits<ArgArray<T>>::ArgsType
operator +(const T& x, const ArgArray<T>& y);
/**
* \brief Argument array for non-primitive types
*
* Argument arrays are used as convenient mechanism of passing arguments
* when calling functions as they combine both the size and the elements
* of an array. For a small number of elements, memory is allocated by
* creating an argument array object. Otherwise the memory is allocated
* from the heap.
*
* \ingroup TaskVar
*/
template<class T>
class ArgArray : public ArgArrayBase<T> {
protected:
using ArgArrayBase<T>::a;
public:
using ArgArrayBase<T>::size;
/// \name Constructors and initialization
//@{
/// Allocate empty array
ArgArray(void);
/// Allocate array with \a n elements
explicit ArgArray(int n);
/// Allocate array with \a n elements and initialize with elements from array \a e
ArgArray(int n, const T* e);
/// Initialize from argument array \a a (copy elements)
ArgArray(const ArgArray<T>& a);
/// Initialize from vector \a a
ArgArray(const std::vector<T>& a);
/// Initialize from initializer list \a a
ArgArray(std::initializer_list<T> a);
/// Initialize from InputIterator \a first and \a last
template<class InputIterator>
ArgArray(InputIterator first, InputIterator last);
//@}
/// \name Array elements
//@{
/// Return slice \f$y\f$ of length \a n such that forall \f$0\leq i<n\f$, \f$y_i=x_{\text{start}+i\cdot\text{inc}}\f$
typename ArrayTraits<ArgArray<T>>::ArgsType
slice(int start, int inc=1, int n=-1);
//@}
/// \name Appending elements
//@{
/// Insert a new element \a x at the end of the array (increase size by 1)
typename ArrayTraits<ArgArray<T>>::ArgsType&
operator <<(const T& x);
/// Append \a x to the end of the array
typename ArrayTraits<ArgArray<T>>::ArgsType&
operator <<(const ArgArray<T>& x);
//@}
friend typename ArrayTraits<ArgArray<T>>::ArgsType
operator + <>(const ArgArray<T>& x, const ArgArray<T>& y);
friend typename ArrayTraits<ArgArray<T>>::ArgsType
operator + <>(const ArgArray<T>& x, const T& y);
friend
typename ArrayTraits<ArgArray<T>>::ArgsType
operator + <>(const T& x, const ArgArray<T>& y);
/// Assignment operator
ArgArray& operator =(const ArgArray&) = default;
};
template<class> class VarArgArray;
/** Concatenate \a x and \a y and return result
* \relates ArgArray
*/
template<class Var>
typename ArrayTraits<VarArgArray<Var>>::ArgsType
operator +(const VarArgArray<Var>& x, const VarArgArray<Var>& y);
/** Concatenate \a x and \a y and return result
* \relates ArgArray
*/
template<class Var>
typename ArrayTraits<VarArgArray<Var>>::ArgsType
operator +(const VarArgArray<Var>& x, const Var& y);
/** Concatenate \a x and \a y and return result
* \relates ArgArray
*/
template<class Var>
typename ArrayTraits<VarArgArray<Var>>::ArgsType
operator +(const Var& x, const VarArgArray<Var>& y);
/**
* \brief Argument array for variables
*
* Argument arrays are used as convenient mechanism of passing arguments
* when calling functions as they combine both the size and the elements
* of an array. For a small number of elements, memory is allocated by
* creating an argument array object. Otherwise the memory is allocated
* from the heap.
*
* \ingroup TaskVar
*/
template<class Var>
class VarArgArray : public ArgArrayBase<Var> {
protected:
using ArgArrayBase<Var>::a;
using ArgArrayBase<Var>::n;
public:
using ArgArrayBase<Var>::size;
/// \name Constructors and initialization
//@{
/// Allocate empty array
VarArgArray(void);
/// Allocate array with \a n elements
explicit VarArgArray(int n);
/// Initialize from variable argument array \a a (copy elements)
VarArgArray(const VarArgArray<Var>& a);
/// Initialize from variable array \a a (copy elements)
VarArgArray(const VarArray<Var>& a);
/// Initialize from vector \a a
VarArgArray(const std::vector<Var>& a);
/// Initialize from initializer list \a a
VarArgArray(std::initializer_list<Var> a);
/// Initialize from InputIterator \a first and \a last
template<class InputIterator>
VarArgArray(InputIterator first, InputIterator last);
//@}
/// \name Array elements
//@{
/// Return slice \f$y\f$ of length \a n such that forall \f$0\leq i<n\f$, \f$y_i=x_{\text{start}+i\cdot\text{inc}}\f$
typename ArrayTraits<VarArgArray<Var>>::ArgsType
slice(int start, int inc=1, int n=-1);
//@}
/// \name Appending elements
//@{
/// Insert a new element \a x at the end of the array (increase size by 1)
typename ArrayTraits<VarArgArray<Var>>::ArgsType&
operator <<(const Var& x);
/// Append \a x to the end of the array
typename ArrayTraits<VarArgArray<Var>>::ArgsType&
operator <<(const VarArgArray<Var>& x);
//@}
/// Test if all variables are assigned
bool assigned(void) const;
friend typename ArrayTraits<VarArgArray<Var>>::ArgsType
operator + <>(const VarArgArray<Var>& x, const VarArgArray<Var>& y);
friend typename ArrayTraits<VarArgArray<Var>>::ArgsType
operator + <>(const VarArgArray<Var>& x, const Var& y);
friend
typename ArrayTraits<VarArgArray<Var>>::ArgsType
operator + <>(const Var& x, const VarArgArray<Var>& y);
/// Assignment operator
VarArgArray& operator =(const VarArgArray&) = default;
};
/**
* \brief Test whether array \a x together with array \a y contains at least one variable being the same
*
* Note that assigned variables are ignored.
* \relates VarArgArray
*/
template<class Var>
bool same(VarArgArray<Var> x, VarArgArray<Var> y);
/**
* \brief Test whether array \a x contains variable \a y
*
* Note that assigned variables are ignored.
* \relates VarArgArray
*/
template<class Var>
bool same(VarArgArray<Var> x, Var y);
/**
* \brief Test whether array \a y contains variable \a x
*
* Note that assigned variables are ignored.
* \relates VarArgArray
*/
template<class Var>
bool same(Var x, VarArgArray<Var> y);
/**
* \brief Test whether array \a x contains a variable multiply
*
* Note that assigned variables are ignored.
* \relates VarArgArray
*/
template<class Var>
bool same(VarArgArray<Var> x);
/**
* \brief Print array elements enclosed in curly brackets
* \relates VarArray
*/
template<class Char, class Traits, class Var>
std::basic_ostream<Char,Traits>&
operator <<(std::basic_ostream<Char,Traits>& os,
const VarArray<Var>& x);
/**
* \brief Print array elements enclosed in curly brackets
* \relates ViewArray
*/
template<class Char, class Traits, class View>
std::basic_ostream<Char,Traits>&
operator <<(std::basic_ostream<Char,Traits>& os, const ViewArray<View>& x);
/**
* \brief Print array elements enclosed in curly brackets
* \relates ArgArrayBase
*/
template<class Char, class Traits, class T>
std::basic_ostream<Char,Traits>&
operator <<(std::basic_ostream<Char,Traits>& os, const ArgArrayBase<T>& x);
/*
* Implementation
*
*/
/*
* Variable arrays
*
* These arrays are allocated in the space.
*
*/
template<class Var>
forceinline
VarArray<Var>::VarArray(void) : n(0), x(nullptr) {}
template<class Var>
forceinline
VarArray<Var>::VarArray(Space& home, int n0)
: n(n0) {
// Allocate from space
x = (n>0) ? home.alloc<Var>(n) : nullptr;
}
template<class Var>
forceinline
VarArray<Var>::VarArray(const VarArray<Var>& a) {
n = a.n; x = a.x;
}
template<class Var>
inline const VarArray<Var>&
VarArray<Var>::operator =(const VarArray<Var>& a) {
n = a.n; x = a.x;
return *this;
}
template<class Var>
forceinline int
VarArray<Var>::size(void) const {
return n;
}
template<class Var>
forceinline Var&
VarArray<Var>::operator [](int i) {
assert((i >= 0) && (i < size()));
return x[i];
}
template<class Var>
forceinline const Var&
VarArray<Var>::operator [](int i) const {
assert((i >= 0) && (i < size()));
return x[i];
}
template<class Var>
typename ArrayTraits<VarArgArray<Var>>::ArgsType
VarArray<Var>::slice(int start, int inc, int maxN) {
assert(n==0 || start < n);
if (n==0 || maxN<0)
maxN = n;
int s;
if (inc == 0)
s = n-start;
else if (inc > 0)
s = (n-start)/inc + ((n-start) % inc == 0 ? 0 : 1);
else
s = (start+1)/-inc + ((start+1) % -inc == 0 ? 0 : 1);
typename ArrayTraits<VarArgArray<Var>>::ArgsType r(std::min(maxN,s));
for (int i=0; i<r.size(); i++, start+=inc)
r[i] = x[start];
return r;
}
template<class Var>
forceinline typename VarArray<Var>::iterator
VarArray<Var>::begin(void) {
return x;
}
template<class Var>
forceinline typename VarArray<Var>::const_iterator
VarArray<Var>::begin(void) const {
return x;
}
template<class Var>
forceinline typename VarArray<Var>::iterator
VarArray<Var>::end(void) {
return x+n;
}
template<class Var>
forceinline typename VarArray<Var>::const_iterator
VarArray<Var>::end(void) const {
return x+n;
}
template<class Var>
forceinline typename VarArray<Var>::reverse_iterator
VarArray<Var>::rbegin(void) {
return reverse_iterator(x+n);