forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkDataArrayTupleRange_Generic.h
1756 lines (1485 loc) · 60.3 KB
/
vtkDataArrayTupleRange_Generic.h
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
/*=========================================================================
Program: Visualization Toolkit
Module: vtkDataArrayTupleRange_Generic.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* Generic implementation of value ranges and iterators, suitable for
* vtkDataArray and all subclasses.
*/
#ifndef vtkDataArrayTupleRange_Generic_h
#define vtkDataArrayTupleRange_Generic_h
#include "vtkAssume.h"
#include "vtkDataArrayAccessor.h"
#include "vtkDataArrayMeta.h"
#include <algorithm>
#include <cassert>
#include <iterator>
#include <type_traits>
#ifndef __VTK_WRAP__
VTK_ITER_OPTIMIZE_START
namespace vtk
{
namespace detail
{
// Forward decs for friends/args
template <typename ArrayType, ComponentIdType>
struct ConstComponentReference;
template <typename ArrayType, ComponentIdType>
struct ComponentReference;
template <typename ArrayType, ComponentIdType>
struct ConstComponentIterator;
template <typename ArrayType, ComponentIdType>
struct ComponentIterator;
template <typename ArrayType, ComponentIdType>
struct ConstTupleReference;
template <typename ArrayType, ComponentIdType>
struct TupleReference;
template <typename ArrayType, ComponentIdType>
struct ConstTupleIterator;
template <typename ArrayType, ComponentIdType>
struct TupleIterator;
template <typename ArrayType, ComponentIdType>
struct TupleRange;
//------------------------------------------------------------------------------
// Const component reference
template <typename ArrayType, ComponentIdType TupleSize>
struct ConstComponentReference
{
private:
static_assert(IsValidTupleSize<TupleSize>::value, "Invalid tuple size.");
static_assert(IsVtkDataArray<ArrayType>::value, "Invalid array type.");
using NumCompsType = GenericTupleSize<TupleSize>;
using APIType = GetAPIType<ArrayType>;
public:
using value_type = APIType;
VTK_ITER_INLINE
ConstComponentReference() noexcept
: Array{ nullptr }
, NumComps{}
, TupleId{ 0 }
, ComponentId{ 0 }
{
}
VTK_ITER_INLINE
ConstComponentReference(
ArrayType* array, NumCompsType numComps, TupleIdType tuple, ComponentIdType comp) noexcept
: Array{ array }
, NumComps{ numComps }
, TupleId{ tuple }
, ComponentId{ comp }
{
VTK_ITER_ASSERT(array != nullptr, "Invalid array.");
VTK_ITER_ASSERT(numComps.value > 0, "Invalid number of components.");
VTK_ITER_ASSERT(
tuple >= 0 && tuple <= array->GetNumberOfTuples(), "Invalid tuple accessed by iterator.");
VTK_ITER_ASSERT(comp >= 0 && comp <= array->GetNumberOfComponents(),
"Invalid component accessed by iterator.");
}
VTK_ITER_INLINE
ConstComponentReference(const ComponentReference<ArrayType, TupleSize>& o)
: Array{ o.Array }
, NumComps{ o.NumComps }
, TupleId{ o.TupleId }
, ComponentId{ o.ComponentId }
{
}
VTK_ITER_INLINE
ConstComponentReference(const ConstComponentReference& o) noexcept = default;
VTK_ITER_INLINE
ConstComponentReference(ConstComponentReference&& o) noexcept = default;
VTK_ITER_INLINE
ConstComponentReference& operator=(const ConstComponentReference& o) noexcept
{
VTK_ITER_ASSERT(!this->Array, "Const reference already initialized.");
// Initialize the reference.
this->Array = o.Array;
this->NumComps = o.NumComps;
this->TupleId = o.TupleId;
this->ComponentId = o.ComponentId;
}
VTK_ITER_INLINE
ConstComponentReference& operator=(ConstComponentReference&& o) noexcept
{
VTK_ITER_ASSERT(!this->Array, "Const reference already initialized.");
// Initialize the reference.
this->Array = std::move(o.Array);
this->NumComps = std::move(o.NumComps);
this->TupleId = std::move(o.TupleId);
this->ComponentId = std::move(o.ComponentId);
}
VTK_ITER_INLINE
operator APIType() const noexcept
{
VTK_ITER_ASSUME(this->NumComps.value > 0);
VTK_ITER_ASSUME(this->Array->GetNumberOfComponents() == this->NumComps.value);
vtkDataArrayAccessor<ArrayType> acc{ this->Array };
return acc.Get(this->TupleId, this->ComponentId);
}
protected:
mutable ArrayType* Array;
NumCompsType NumComps;
TupleIdType TupleId;
ComponentIdType ComponentId;
};
//------------------------------------------------------------------------------
// Component reference
template <typename ArrayType, ComponentIdType TupleSize>
struct ComponentReference
{
private:
static_assert(IsValidTupleSize<TupleSize>::value, "Invalid tuple size.");
static_assert(IsVtkDataArray<ArrayType>::value, "Invalid array type.");
using NumCompsType = GenericTupleSize<TupleSize>;
using APIType = GetAPIType<ArrayType>;
public:
using value_type = APIType;
VTK_ITER_INLINE
ComponentReference() noexcept
: Array{ nullptr }
, NumComps{}
, TupleId{ 0 }
, ComponentId{ 0 }
{
}
VTK_ITER_INLINE
ComponentReference(
ArrayType* array, NumCompsType numComps, TupleIdType tuple, ComponentIdType comp) noexcept
: Array{ array }
, NumComps{ numComps }
, TupleId{ tuple }
, ComponentId{ comp }
{
VTK_ITER_ASSERT(array != nullptr, "Invalid array.");
VTK_ITER_ASSERT(numComps.value > 0, "Invalid number of components.");
VTK_ITER_ASSERT(
tuple >= 0 && tuple <= array->GetNumberOfTuples(), "Invalid tuple accessed by iterator.");
VTK_ITER_ASSERT(comp >= 0 && comp <= array->GetNumberOfComponents(),
"Invalid component accessed by iterator.");
}
VTK_ITER_INLINE
ComponentReference(const ComponentReference& o) noexcept = default;
VTK_ITER_INLINE
ComponentReference(ComponentReference&& o) noexcept = default;
VTK_ITER_INLINE
ComponentReference operator=(const ComponentReference& o) noexcept
{
if (this->Array)
{ // Already initialized. Assign the value, not the reference
return *this = static_cast<APIType>(o);
}
else
{ // Initialize the reference.
this->Array = o.Array;
this->NumComps = o.NumComps;
this->TupleId = o.TupleId;
this->ComponentId = o.ComponentId;
return *this;
}
}
VTK_ITER_INLINE
ComponentReference operator=(ComponentReference&& o) noexcept
{
if (this->Array)
{ // Already initialized. Assign the value, not the reference
return *this = std::move(static_cast<APIType>(o));
}
else
{ // Initialize the reference.
this->Array = std::move(o.Array);
this->NumComps = std::move(o.NumComps);
this->TupleId = std::move(o.TupleId);
this->ComponentId = std::move(o.ComponentId);
return *this;
}
}
template <typename OArray, ComponentIdType OSize>
VTK_ITER_INLINE ComponentReference operator=(const ComponentReference<OArray, OSize>& o) noexcept
{ // Always copy the value for different reference types:
const APIType tmp = o;
return *this = std::move(tmp);
}
VTK_ITER_INLINE
operator APIType() const noexcept
{
VTK_ITER_ASSUME(this->NumComps.value > 0);
VTK_ITER_ASSUME(this->Array->GetNumberOfComponents() == this->NumComps.value);
vtkDataArrayAccessor<ArrayType> acc{ this->Array };
return acc.Get(this->TupleId, this->ComponentId);
}
VTK_ITER_INLINE
ComponentReference operator=(APIType val) noexcept
{
VTK_ITER_ASSUME(this->NumComps.value > 0);
VTK_ITER_ASSUME(this->Array->GetNumberOfComponents() == this->NumComps.value);
vtkDataArrayAccessor<ArrayType> acc{ this->Array };
acc.Set(this->TupleId, this->ComponentId, val);
return *this;
}
friend VTK_ITER_INLINE void swap(ComponentReference lhs, ComponentReference rhs) noexcept
{ // Swap values, not references:
APIType tmp = std::move(static_cast<APIType>(lhs));
lhs = std::move(static_cast<APIType>(rhs));
rhs = std::move(tmp);
}
template <typename OArray, ComponentIdType OSize>
friend VTK_ITER_INLINE void swap(
ComponentReference lhs, ComponentReference<OArray, OSize> rhs) noexcept
{ // Swap values, not references:
using OAPIType = GetAPIType<OArray>;
static_assert(
std::is_same<APIType, OAPIType>::value, "Cannot swap components with different types.");
APIType tmp = std::move(static_cast<APIType>(lhs));
lhs = std::move(static_cast<APIType>(rhs));
rhs = std::move(tmp);
}
friend VTK_ITER_INLINE void swap(ComponentReference lhs, APIType& rhs) noexcept
{
APIType tmp = std::move(static_cast<APIType>(lhs));
lhs = std::move(rhs);
rhs = std::move(tmp);
}
friend VTK_ITER_INLINE void swap(APIType& lhs, ComponentReference rhs) noexcept
{
APIType tmp = std::move(lhs);
lhs = std::move(static_cast<APIType>(rhs));
rhs = std::move(tmp);
}
VTK_ITER_INLINE
ComponentReference operator++() noexcept // prefix
{
const APIType newVal = *this + 1;
*this = newVal;
return *this;
}
VTK_ITER_INLINE
APIType operator++(int) noexcept // postfix
{
const APIType retVal = *this;
*this = *this + 1;
return retVal;
}
VTK_ITER_INLINE
ComponentReference operator--() noexcept // prefix
{
const APIType newVal = *this - 1;
*this = newVal;
return *this;
}
VTK_ITER_INLINE
APIType operator--(int) noexcept // postfix
{
const APIType retVal = *this;
*this = *this - 1;
return retVal;
}
#define VTK_REF_OP_OVERLOADS(Op, ImplOp) \
friend VTK_ITER_INLINE ComponentReference operator Op( \
ComponentReference lhs, APIType val) noexcept \
{ \
const APIType newVal = lhs ImplOp val; \
lhs = newVal; \
return lhs; \
} \
friend VTK_ITER_INLINE ComponentReference operator Op( \
ComponentReference lhs, ComponentReference val) noexcept \
{ \
const APIType newVal = lhs ImplOp val; \
lhs = newVal; \
return lhs; \
} \
friend VTK_ITER_INLINE APIType& operator Op(APIType& lhs, ComponentReference val) noexcept \
{ \
const APIType newVal = lhs ImplOp val; \
lhs = newVal; \
return lhs; \
}
VTK_REF_OP_OVERLOADS(+=, +)
VTK_REF_OP_OVERLOADS(-=, -)
VTK_REF_OP_OVERLOADS(*=, *)
VTK_REF_OP_OVERLOADS(/=, /)
#undef VTK_REF_OP_OVERLOADS
friend struct ConstComponentReference<ArrayType, TupleSize>;
friend struct ComponentIterator<ArrayType, TupleSize>;
protected:
VTK_ITER_INLINE
void CopyReference(const ComponentReference& o) noexcept
{
this->Array = o.Array;
this->NumComps = o.NumComps;
this->TupleId = o.TupleId;
this->ComponentId = o.ComponentId;
}
mutable ArrayType* Array;
NumCompsType NumComps;
TupleIdType TupleId;
ComponentIdType ComponentId;
};
//------------------------------------------------------------------------------
// Const component iterator
template <typename ArrayType, ComponentIdType TupleSize>
struct ConstComponentIterator
{
private:
static_assert(IsValidTupleSize<TupleSize>::value, "Invalid tuple size.");
static_assert(IsVtkDataArray<ArrayType>::value, "Invalid array type.");
using NumCompsType = GenericTupleSize<TupleSize>;
public:
using iterator_category = std::random_access_iterator_tag;
using value_type = GetAPIType<ArrayType>;
using difference_type = ComponentIdType;
using pointer = void;
using reference = ConstComponentReference<ArrayType, TupleSize>;
VTK_ITER_INLINE
ConstComponentIterator() noexcept
: Array{ nullptr }
, TupleId{ 0 }
, ComponentId{ 0 }
{
}
VTK_ITER_INLINE
ConstComponentIterator(
ArrayType* array, NumCompsType numComps, TupleIdType tupleId, ComponentIdType comp) noexcept
: Array(array)
, NumComps(numComps)
, TupleId(tupleId)
, ComponentId(comp)
{
VTK_ITER_ASSERT(array != nullptr, "Invalid array.");
VTK_ITER_ASSERT(numComps.value > 0, "Invalid number of components.");
VTK_ITER_ASSERT(tupleId >= 0 && tupleId <= array->GetNumberOfTuples(),
"Const component iterator at invalid tuple id.");
VTK_ITER_ASSERT(comp >= 0 && comp <= this->NumComps.value,
"Const component iterator at invalid component id.");
}
VTK_ITER_INLINE
ConstComponentIterator(const ComponentIterator<ArrayType, TupleSize>& o) noexcept
: Array{ o.GetArray() }
, NumComps{ o.GetNumComps() }
, TupleId{ o.GetTupleId() }
, ComponentId{ o.GetComponentId() }
{
}
VTK_ITER_INLINE
ConstComponentIterator(const ConstComponentIterator& o) noexcept = default;
VTK_ITER_INLINE
ConstComponentIterator& operator=(const ConstComponentIterator& o) noexcept = default;
VTK_ITER_INLINE
ConstComponentIterator& operator++() noexcept // prefix
{
++this->ComponentId;
VTK_ITER_ASSERT(this->ComponentId >= 0 && this->ComponentId <= this->NumComps.value,
"Const component iterator at invalid component id.");
return *this;
}
VTK_ITER_INLINE
ConstComponentIterator operator++(int) noexcept // postfix
{
return ConstComponentIterator{ this->Array, this->NumComps, this->TupleId,
this->ComponentId++ };
}
VTK_ITER_INLINE
ConstComponentIterator& operator--() noexcept // prefix
{
--this->ComponentId;
VTK_ITER_ASSERT(this->ComponentId >= 0 && this->ComponentId <= this->NumComps.value,
"Const component iterator at invalid component id.");
return *this;
}
VTK_ITER_INLINE
ConstComponentIterator operator--(int) noexcept // postfix
{
return ConstComponentIterator{ this->Array, this->NumComps, this->TupleId,
this->ComponentId-- };
}
VTK_ITER_INLINE
reference operator[](difference_type i) const noexcept
{
return reference{ this->Array, this->NumComps, this->TupleId, this->ComponentId + i };
}
VTK_ITER_INLINE
reference operator*() const noexcept
{
return reference{ this->Array, this->NumComps, this->TupleId, this->ComponentId };
}
#define VTK_TMP_MAKE_OPERATOR(OP) \
friend VTK_ITER_INLINE bool operator OP( \
const ConstComponentIterator& lhs, const ConstComponentIterator& rhs) noexcept \
{ \
VTK_ITER_ASSERT(lhs.Array == rhs.Array, "Mismatched arrays in iterator comparison."); \
VTK_ITER_ASSERT(lhs.TupleId == rhs.TupleId, "Mismatched tuple ids in iterator comparison."); \
VTK_ITER_ASSUME(lhs.NumComps.value > 0); \
VTK_ITER_ASSUME(lhs.NumComps.value == rhs.NumComps.value); \
return lhs.ComponentId OP rhs.ComponentId; \
}
VTK_TMP_MAKE_OPERATOR(==)
VTK_TMP_MAKE_OPERATOR(!=)
VTK_TMP_MAKE_OPERATOR(<)
VTK_TMP_MAKE_OPERATOR(>)
VTK_TMP_MAKE_OPERATOR(<=)
VTK_TMP_MAKE_OPERATOR(>=)
#undef VTK_TMP_MAKE_OPERATOR
VTK_ITER_INLINE
ConstComponentIterator& operator+=(difference_type offset) noexcept
{
this->ComponentId += offset;
VTK_ITER_ASSERT(this->ComponentId >= 0 && this->ComponentId <= this->NumComps.value,
"Const component iterator at invalid component id.");
return *this;
}
friend VTK_ITER_INLINE ConstComponentIterator operator+(
const ConstComponentIterator& it, difference_type offset) noexcept
{
return ConstComponentIterator{ it.Array, it.NumComps, it.TupleId, it.ComponentId + offset };
}
friend VTK_ITER_INLINE ConstComponentIterator operator+(
difference_type offset, const ConstComponentIterator& it) noexcept
{
return ConstComponentIterator{ it.Array, it.NumComps, it.TupleId, it.ComponentId + offset };
}
VTK_ITER_INLINE
ConstComponentIterator& operator-=(difference_type offset) noexcept
{
this->ComponentId -= offset;
VTK_ITER_ASSERT(this->ComponentId >= 0 && this->ComponentId <= this->NumComps.value,
"Const component iterator at invalid component id.");
return *this;
}
friend VTK_ITER_INLINE ConstComponentIterator operator-(
const ConstComponentIterator& it, difference_type offset) noexcept
{
return ConstComponentIterator{ it.Array, it.NumComps, it.TupleId, it.ComponentId - offset };
}
friend VTK_ITER_INLINE difference_type operator-(
const ConstComponentIterator& it1, const ConstComponentIterator& it2) noexcept
{
VTK_ITER_ASSERT(it1.Array == it2.Array, "Cannot do math with iterators from different arrays.");
VTK_ITER_ASSERT(it1.TupleId == it2.TupleId,
"Cannot do math with component iterators from different "
"tuples.");
return it1.ComponentId - it2.ComponentId;
}
friend VTK_ITER_INLINE void swap(
ConstComponentIterator& lhs, ConstComponentIterator& rhs) noexcept
{
// Different arrays may use different iterator implementations.
VTK_ITER_ASSERT(lhs.Array == rhs.Array, "Cannot swap iterators from different arrays.");
using std::swap;
swap(lhs.TupleId, rhs.TupleId);
swap(lhs.ComponentId, rhs.ComponentId);
}
private:
mutable ArrayType* Array;
NumCompsType NumComps;
TupleIdType TupleId;
ComponentIdType ComponentId;
};
//------------------------------------------------------------------------------
// Component iterator
template <typename ArrayType, ComponentIdType TupleSize>
struct ComponentIterator
{
private:
static_assert(IsValidTupleSize<TupleSize>::value, "Invalid tuple size.");
static_assert(IsVtkDataArray<ArrayType>::value, "Invalid array type.");
using NumCompsType = GenericTupleSize<TupleSize>;
using APIType = GetAPIType<ArrayType>;
public:
using iterator_category = std::random_access_iterator_tag;
using value_type = APIType;
using difference_type = ComponentIdType;
using pointer = ComponentReference<ArrayType, TupleSize>;
using reference = ComponentReference<ArrayType, TupleSize>;
VTK_ITER_INLINE
ComponentIterator() noexcept = default;
VTK_ITER_INLINE
ComponentIterator(
ArrayType* array, NumCompsType numComps, TupleIdType tupleId, ComponentIdType comp) noexcept
: Ref(array, numComps, tupleId, comp)
{
VTK_ITER_ASSERT(array != nullptr, "Invalid array.");
VTK_ITER_ASSERT(numComps.value > 0, "Invalid number of components.");
VTK_ITER_ASSERT(tupleId >= 0 && tupleId <= array->GetNumberOfTuples(),
"Component iterator at invalid tuple id.");
VTK_ITER_ASSERT(
comp >= 0 && comp <= numComps.value, "Component iterator at invalid component id.");
}
VTK_ITER_INLINE
ComponentIterator(const ComponentIterator& o) noexcept = default;
VTK_ITER_INLINE
ComponentIterator& operator=(const ComponentIterator& o) noexcept
{
this->Ref.CopyReference(o.Ref);
return *this;
}
VTK_ITER_INLINE
ComponentIterator& operator++() noexcept // prefix
{
++this->Ref.ComponentId;
VTK_ITER_ASSERT(this->Ref.ComponentId >= 0 && this->Ref.ComponentId <= this->Ref.NumComps.value,
"Component iterator at invalid component id.");
return *this;
}
VTK_ITER_INLINE
ComponentIterator operator++(int) noexcept // postfix
{
return ComponentIterator{ this->Ref.Array, this->Ref.NumComps, this->Ref.TupleId,
this->Ref.ComponentId++ };
}
VTK_ITER_INLINE
ComponentIterator& operator--() noexcept // prefix
{
--this->Ref.ComponentId;
VTK_ITER_ASSERT(this->Ref.ComponentId >= 0 && this->Ref.ComponentId <= this->Ref.NumComps.value,
"Component iterator at invalid component id.");
return *this;
}
VTK_ITER_INLINE
ComponentIterator operator--(int) noexcept // postfix
{
return ComponentIterator{ this->Ref.Array, this->Ref.NumComps, this->Ref.TupleId,
this->Ref.ComponentId-- };
}
VTK_ITER_INLINE
reference operator[](difference_type i) const noexcept
{
return reference{ this->Ref.Array, this->Ref.NumComps, this->Ref.TupleId,
this->Ref.ComponentId + i };
}
VTK_ITER_INLINE
reference operator*() const noexcept { return this->Ref; }
VTK_ITER_INLINE
const pointer& operator->() const noexcept { return this->Ref; }
#define VTK_TMP_MAKE_OPERATOR(OP) \
friend VTK_ITER_INLINE bool operator OP( \
const ComponentIterator& lhs, const ComponentIterator& rhs) noexcept \
{ \
VTK_ITER_ASSERT( \
lhs.GetArray() == rhs.GetArray(), "Mismatched arrays in iterator comparison."); \
VTK_ITER_ASSERT( \
lhs.GetTupleId() == rhs.GetTupleId(), "Mismatched tuple ids in iterator comparison."); \
VTK_ITER_ASSUME(lhs.GetNumComps().value > 0); \
VTK_ITER_ASSUME(lhs.GetNumComps().value == rhs.GetNumComps().value); \
return lhs.GetComponentId() OP rhs.GetComponentId(); \
}
VTK_TMP_MAKE_OPERATOR(==)
VTK_TMP_MAKE_OPERATOR(!=)
VTK_TMP_MAKE_OPERATOR(<)
VTK_TMP_MAKE_OPERATOR(>)
VTK_TMP_MAKE_OPERATOR(<=)
VTK_TMP_MAKE_OPERATOR(>=)
#undef VTK_TMP_MAKE_OPERATOR
VTK_ITER_INLINE
ComponentIterator& operator+=(difference_type offset) noexcept
{
this->Ref.ComponentId += offset;
VTK_ITER_ASSERT(this->Ref.ComponentId >= 0 && this->Ref.ComponentId <= this->Ref.NumComps.value,
"Component iterator at invalid component id.");
return *this;
}
friend VTK_ITER_INLINE ComponentIterator operator+(
const ComponentIterator& it, difference_type offset) noexcept
{
return ComponentIterator{ it.GetArray(), it.GetNumComps(), it.GetTupleId(),
it.GetComponentId() + offset };
}
friend VTK_ITER_INLINE ComponentIterator operator+(
difference_type offset, const ComponentIterator& it) noexcept
{
return ComponentIterator{ it.GetArray(), it.GetNumComps(), it.GetTupleId(),
it.GetComponentId() + offset };
}
VTK_ITER_INLINE
ComponentIterator& operator-=(difference_type offset) noexcept
{
this->Ref.ComponentId -= offset;
VTK_ITER_ASSERT(this->Ref.ComponentId >= 0 && this->Ref.ComponentId <= this->Ref.NumComps.value,
"Component iterator at invalid component id.");
return *this;
}
friend VTK_ITER_INLINE ComponentIterator operator-(
const ComponentIterator& it, difference_type offset) noexcept
{
return ComponentIterator{ it.GetArray(), it.GetNumComps(), it.GetTupleId(),
it.GetComponentId() - offset };
}
friend VTK_ITER_INLINE difference_type operator-(
const ComponentIterator& it1, const ComponentIterator& it2) noexcept
{
VTK_ITER_ASSERT(it1.GetArray() == it2.GetArray(),
"Cannot do math with component iterators from different "
"arrays.");
VTK_ITER_ASSERT(it1.GetTupleId() == it2.GetTupleId(),
"Cannot do math with component iterators from different "
"tuples.");
return it1.GetComponentId() - it2.GetComponentId();
}
friend VTK_ITER_INLINE void swap(ComponentIterator& lhs, ComponentIterator& rhs) noexcept
{
// Different arrays may use different iterator implementations.
VTK_ITER_ASSERT(
lhs.GetArray() == rhs.GetArray(), "Cannot swap iterators from different arrays.");
using std::swap;
swap(lhs.GetTupleId(), rhs.GetTupleId());
swap(lhs.GetComponentId(), rhs.GetComponentId());
}
friend struct ConstComponentIterator<ArrayType, TupleSize>;
protected:
// Needed for access from friend functions. We could just store the array
// and ID here instead of the ref, but meh.
ArrayType* GetArray() const noexcept { return this->Ref.Array; }
TupleIdType& GetTupleId() noexcept { return this->Ref.TupleId; }
const TupleIdType& GetTupleId() const noexcept { return this->Ref.TupleId; }
ComponentIdType& GetComponentId() noexcept { return this->Ref.ComponentId; }
const ComponentIdType& GetComponentId() const noexcept { return this->Ref.ComponentId; }
NumCompsType& GetNumComps() noexcept { return this->Ref.NumComps; }
const NumCompsType& GetNumComps() const noexcept { return this->Ref.NumComps; }
ComponentReference<ArrayType, TupleSize> Ref;
};
//------------------------------------------------------------------------------
// Const tuple reference
template <typename ArrayType, ComponentIdType TupleSize>
struct ConstTupleReference
{
private:
static_assert(IsValidTupleSize<TupleSize>::value, "Invalid tuple size.");
static_assert(IsVtkDataArray<ArrayType>::value, "Invalid array type.");
using NumCompsType = GenericTupleSize<TupleSize>;
using APIType = GetAPIType<ArrayType>;
public:
using size_type = ComponentIdType;
using value_type = APIType;
using iterator = ConstComponentIterator<ArrayType, TupleSize>;
using const_iterator = ConstComponentIterator<ArrayType, TupleSize>;
using const_reference = ConstComponentReference<ArrayType, TupleSize>;
VTK_ITER_INLINE
ConstTupleReference() noexcept
: Array(nullptr)
, TupleId(0)
{
}
VTK_ITER_INLINE
ConstTupleReference(ArrayType* array, NumCompsType numComps, TupleIdType tupleId) noexcept
: Array(array)
, NumComps(numComps)
, TupleId(tupleId)
{
VTK_ITER_ASSERT(array != nullptr, "Invalid array.");
VTK_ITER_ASSERT(numComps.value > 0, "Invalid number of components.");
VTK_ITER_ASSERT(tupleId >= 0 && tupleId <= array->GetNumberOfTuples(),
"Const tuple reference at invalid tuple id.");
}
VTK_ITER_INLINE
ConstTupleReference(const TupleReference<ArrayType, TupleSize>& o) noexcept
: Array{ o.Array }
, NumComps{ o.NumComps }
, TupleId{ o.TupleId }
{
}
VTK_ITER_INLINE
ConstTupleReference(const ConstTupleReference&) noexcept = default;
VTK_ITER_INLINE
ConstTupleReference(ConstTupleReference&&) noexcept = default;
// Allow this type to masquerade as a pointer, so that tupleIiter->foo works.
VTK_ITER_INLINE
ConstTupleReference* operator->() noexcept { return this; }
VTK_ITER_INLINE
const ConstTupleReference* operator->() const noexcept { return this; }
// Caller must ensure that there are size() elements in array.
VTK_ITER_INLINE
void GetTuple(APIType* tuple) const noexcept
{
VTK_ITER_ASSUME(this->NumComps.value > 0);
VTK_ITER_ASSUME(this->Array->GetNumberOfComponents() == this->NumComps.value);
vtkDataArrayAccessor<ArrayType> acc{ this->Array };
acc.Get(this->TupleId, tuple);
}
// skips some runtime checks when both sizes are fixed:
template <typename OArrayType, ComponentIdType OSize>
VTK_ITER_INLINE EnableIfStaticTupleSizes<TupleSize, OSize, bool> operator==(
const TupleReference<OArrayType, OSize>& other) const noexcept
{
// Check that types are convertible:
using OAPIType = GetAPIType<OArrayType>;
static_assert(
(std::is_convertible<OAPIType, APIType>{}), "Incompatible types when comparing tuples.");
// SFINAE guarantees that the tuple sizes are not dynamic in this overload:
static_assert(TupleSize == OSize, "Cannot compare tuples with different sizes.");
return std::equal(this->cbegin(), this->cend(), other.cbegin());
}
// Needs a runtime check:
template <typename OArrayType, ComponentIdType OSize>
VTK_ITER_INLINE EnableIfEitherTupleSizeIsDynamic<TupleSize, OSize, bool> operator==(
const TupleReference<OArrayType, OSize>& other) const noexcept
{
// Check that types are convertible:
using OAPIType = GetAPIType<OArrayType>;
static_assert(
(std::is_convertible<OAPIType, APIType>{}), "Incompatible types when comparing tuples.");
VTK_ITER_ASSERT(
other.size() == this->NumComps.value, "Cannot compare tuples with different sizes.");
return std::equal(this->cbegin(), this->cend(), other.cbegin());
}
// skips some runtime checks when both sizes are fixed:
template <typename OArrayType, ComponentIdType OSize>
VTK_ITER_INLINE EnableIfStaticTupleSizes<TupleSize, OSize, bool> operator==(
const ConstTupleReference<OArrayType, OSize>& other) const noexcept
{
// Check that types are convertible:
using OAPIType = GetAPIType<OArrayType>;
static_assert(
(std::is_convertible<OAPIType, APIType>{}), "Incompatible types when comparing tuples.");
// SFINAE guarantees that the tuple sizes are not dynamic in this overload:
static_assert(TupleSize == OSize, "Cannot compare tuples with different sizes.");
return std::equal(this->cbegin(), this->cend(), other.cbegin());
}
// Needs a runtime check:
template <typename OArrayType, ComponentIdType OSize>
VTK_ITER_INLINE EnableIfEitherTupleSizeIsDynamic<TupleSize, OSize, bool> operator==(
const ConstTupleReference<OArrayType, OSize>& other) const noexcept
{
// Check that types are convertible:
using OAPIType = GetAPIType<OArrayType>;
static_assert(
(std::is_convertible<OAPIType, APIType>{}), "Incompatible types when comparing tuples.");
VTK_ITER_ASSERT(
other.size() == this->NumComps.value, "Cannot compare tuples with different sizes.");
return std::equal(this->cbegin(), this->cend(), other.cbegin());
}
template <typename OArrayType, ComponentIdType OSize>
VTK_ITER_INLINE bool operator!=(const TupleReference<OArrayType, OSize>& o) const noexcept
{
return !(*this == o);
}
template <typename OArrayT, ComponentIdType OSize>
VTK_ITER_INLINE bool operator!=(const ConstTupleReference<OArrayT, OSize>& o) const noexcept
{
return !(*this == o);
}
VTK_ITER_INLINE
const_reference operator[](size_type i) const noexcept
{
return const_reference{ this->Array, this->NumComps, this->TupleId, i };
}
VTK_ITER_INLINE
size_type size() const noexcept { return this->NumComps.value; }
VTK_ITER_INLINE
const_iterator begin() const noexcept { return this->NewConstIterator(0); }
VTK_ITER_INLINE
const_iterator end() const noexcept { return this->NewConstIterator(this->NumComps.value); }
VTK_ITER_INLINE
const_iterator cbegin() const noexcept { return this->NewConstIterator(0); }
VTK_ITER_INLINE
const_iterator cend() const noexcept { return this->NewConstIterator(this->NumComps.value); }
friend struct ConstTupleIterator<ArrayType, TupleSize>;
protected:
// Intentionally hidden:
VTK_ITER_INLINE
ConstTupleReference& operator=(const ConstTupleReference&) noexcept = default;
VTK_ITER_INLINE
const_iterator NewConstIterator(ComponentIdType comp) const noexcept
{
VTK_ITER_ASSUME(this->NumComps.value > 0);
return const_iterator{ this->Array, this->NumComps, this->TupleId, comp };
}
VTK_ITER_INLINE
void CopyReference(const ConstTupleReference& o) noexcept
{
// Must use same array, other array types may use different implementations.
VTK_ITER_ASSERT(this->Array == o.Array, "Cannot copy reference objects between arrays.");
this->NumComps = o.NumComps;
this->TupleId = o.TupleId;
}
mutable ArrayType* Array;
NumCompsType NumComps;
TupleIdType TupleId;
};
//------------------------------------------------------------------------------
// Tuple reference
template <typename ArrayType, ComponentIdType TupleSize>
struct TupleReference
{
private:
static_assert(IsValidTupleSize<TupleSize>::value, "Invalid tuple size.");
static_assert(IsVtkDataArray<ArrayType>::value, "Invalid array type.");
using NumCompsType = GenericTupleSize<TupleSize>;
using APIType = GetAPIType<ArrayType>;
public:
using size_type = ComponentIdType;
using value_type = APIType;
using iterator = ComponentIterator<ArrayType, TupleSize>;
using const_iterator = ConstComponentIterator<ArrayType, TupleSize>;
using reference = ComponentReference<ArrayType, TupleSize>;
using const_reference = ConstComponentReference<ArrayType, TupleSize>;
VTK_ITER_INLINE
TupleReference() noexcept
: Array(nullptr)
, TupleId(0)
{
}
VTK_ITER_INLINE
TupleReference(ArrayType* array, NumCompsType numComps, TupleIdType tupleId) noexcept
: Array(array)
, NumComps(numComps)
, TupleId(tupleId)
{
VTK_ITER_ASSERT(array != nullptr, "Invalid array.");
VTK_ITER_ASSERT(numComps.value > 0, "Invalid number of components.");
VTK_ITER_ASSERT(tupleId >= 0 && tupleId <= array->GetNumberOfTuples(),
"Tuple reference at invalid tuple id.");
}
VTK_ITER_INLINE
TupleReference(const TupleReference&) = default;
VTK_ITER_INLINE
TupleReference(TupleReference&&) = default;
// Allow this type to masquerade as a pointer, so that tupleIiter->foo works.
VTK_ITER_INLINE
TupleReference* operator->() noexcept { return this; }
VTK_ITER_INLINE
const TupleReference* operator->() const noexcept { return this; }
// Caller must ensure that there are size() elements in array.
VTK_ITER_INLINE
void GetTuple(APIType* tuple) const noexcept
{
VTK_ITER_ASSUME(this->NumComps.value > 0);
VTK_ITER_ASSUME(this->Array->GetNumberOfComponents() == this->NumComps.value);
vtkDataArrayAccessor<ArrayType> acc{ this->Array };
acc.Get(this->TupleId, tuple);
}
// Caller must ensure that there are size() elements in array.