|
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
|
#ifndef DataFormats_SoATemplate_interface_SoAView_h
#define DataFormats_SoATemplate_interface_SoAView_h
/*
* Structure-of-Arrays templates allowing access to a selection of scalars and columns from one
* or multiple SoA layouts or views.
* This template generator will allow handling subsets of columns from one or multiple SoA views or layouts.
*/
#include "SoACommon.h"
#define SOA_VIEW_LAYOUT(TYPE, NAME) (TYPE, NAME)
#define SOA_VIEW_LAYOUT_LIST(...) __VA_ARGS__
#define SOA_VIEW_VALUE(LAYOUT_NAME, LAYOUT_MEMBER) (LAYOUT_NAME, LAYOUT_MEMBER, LAYOUT_MEMBER)
#define SOA_VIEW_VALUE_RENAME(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) (LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME)
#define SOA_VIEW_VALUE_LIST(...) __VA_ARGS__
/*
* A macro defining a SoA view (collection of columns from multiple layouts or views.)
*
* Usage:
* GENERATE_SOA_VIEW(PixelXYConstView, PixelXYView,
* SOA_VIEW_LAYOUT_LIST(
* SOA_VIEW_LAYOUT(PixelDigis, pixelDigis),
* SOA_VIEW_LAYOUT(PixelRecHitsLayout, pixelsRecHit)
* ),
* SOA_VIEW_VALUE_LIST(
* SOA_VIEW_VALUE_RENAME(pixelDigis, x, digisX),
* SOA_VIEW_VALUE_RENAME(pixelDigis, y, digisY),
* SOA_VIEW_VALUE_RENAME(pixelsRecHit, x, recHitsX),
* SOA_VIEW_VALUE_RENAME(pixelsRecHit, y, recHitsY)
* )
* );
*
*/
namespace cms::soa {
/* Traits for the different column type scenarios */
/* Value traits passes the class as is in the case of column type and return
* an empty class with functions returning non-scalar as accessors. */
template <class C, SoAColumnType COLUMN_TYPE>
struct ConstValueTraits : public C {
using C::C;
};
template <class C>
struct ConstValueTraits<C, SoAColumnType::scalar> {
// Just take to SoAValue type to generate the right constructor.
SOA_HOST_DEVICE SOA_INLINE ConstValueTraits(size_type, const typename C::valueType*) {}
SOA_HOST_DEVICE SOA_INLINE ConstValueTraits(size_type, const typename C::Params&) {}
SOA_HOST_DEVICE SOA_INLINE ConstValueTraits(size_type, const typename C::ConstParams&) {}
// Any attempt to do anything with the "scalar" value a const element will fail.
};
} // namespace cms::soa
/*
* Members definitions macros for views
*/
/**
* Layout templates parametrization
*/
#define _DECLARE_VIEW_LAYOUT_PARAMETRIZED_TEMPLATE_IMPL(TYPE, NAME) \
(using BOOST_PP_CAT(TYPE, _default) = BOOST_PP_CAT(TYPE, _StagedTemplates) < VIEW_ALIGNMENT, \
VIEW_ALIGNMENT_ENFORCEMENT > ;)
#define _DECLARE_VIEW_LAYOUT_PARAMETRIZED_TEMPLATE(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_LAYOUT_PARAMETRIZED_TEMPLATE_IMPL TYPE_NAME)
/**
* Layout types aliasing for referencing by name
*/
#define _DECLARE_VIEW_LAYOUT_TYPE_ALIAS_IMPL(TYPE, NAME) using BOOST_PP_CAT(TypeOf_, NAME) = TYPE;
#define _DECLARE_VIEW_LAYOUT_TYPE_ALIAS(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_LAYOUT_TYPE_ALIAS_IMPL TYPE_NAME)
/**
* Member types aliasing for referencing by name
*/
// clang-format off
#define _DECLARE_VIEW_MEMBER_TYPE_ALIAS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, CAST) \
using BOOST_PP_CAT(TypeOf_, LOCAL_NAME) = \
typename BOOST_PP_CAT(TypeOf_, LAYOUT_NAME)::Metadata::BOOST_PP_CAT(TypeOf_, LAYOUT_MEMBER); \
using BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME) = \
typename BOOST_PP_CAT(TypeOf_, LAYOUT_NAME)::Metadata::BOOST_PP_CAT(ParametersTypeOf_, LAYOUT_MEMBER); \
constexpr static cms::soa::SoAColumnType BOOST_PP_CAT(ColumnTypeOf_, LOCAL_NAME) = \
BOOST_PP_CAT(TypeOf_, LAYOUT_NAME)::Metadata::BOOST_PP_CAT(ColumnTypeOf_, LAYOUT_MEMBER); \
using BOOST_PP_CAT(ConstAccessorOf_, LOCAL_NAME) = \
typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::constAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify> ; \
using BOOST_PP_CAT(MutableAccessorOf_, LOCAL_NAME) = \
typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::mutableAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify> ; \
SOA_HOST_DEVICE SOA_INLINE \
const auto BOOST_PP_CAT(parametersOf_, LOCAL_NAME)() const { \
return CAST(parent_.BOOST_PP_CAT(LOCAL_NAME, Parameters_)); \
};
// clang-format on
// DATA should be a function used to convert
// parent_.LOCAL_NAME ## Parameters_
// to
// ParametersTypeOf_ ## LOCAL_NAME (for a View)
// or
// ParametersTypeOf_ ## LOCAL_NAME :: ConstType (for a ConstView)
// or empty, if no conversion is necessary.
#define _DECLARE_VIEW_MEMBER_TYPE_ALIAS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_TYPE_ALIAS_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Member type pointers for referencing by name
*/
// clang-format off
#define _DECLARE_VIEW_MEMBER_POINTERS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
SOA_HOST_DEVICE SOA_INLINE auto* BOOST_PP_CAT(addressOf_, LOCAL_NAME)() { \
return BOOST_PP_CAT(parametersOf_, LOCAL_NAME)().addr_; \
};
// clang-format on
#define _DECLARE_VIEW_MEMBER_POINTERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_POINTERS_IMPL LAYOUT_MEMBER_NAME)
/**
* Member type const pointers for referencing by name
*/
// clang-format off
#define _DECLARE_VIEW_MEMBER_CONST_POINTERS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
SOA_HOST_DEVICE SOA_INLINE auto const* BOOST_PP_CAT(addressOf_, LOCAL_NAME)() const { \
return BOOST_PP_CAT(parametersOf_, LOCAL_NAME)().addr_; \
};
// clang-format on
#define _DECLARE_VIEW_MEMBER_CONST_POINTERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_CONST_POINTERS_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of parameters (layouts/views) for constructor by layouts/views.
*/
#define _DECLARE_VIEW_CONSTRUCTION_PARAMETERS_IMPL(LAYOUT_TYPE, LAYOUT_NAME, DATA) (DATA LAYOUT_TYPE & LAYOUT_NAME)
#define _DECLARE_VIEW_CONSTRUCTION_PARAMETERS(R, DATA, TYPE_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_CONSTRUCTION_PARAMETERS_IMPL BOOST_PP_TUPLE_PUSH_BACK(TYPE_NAME, DATA))
/**
* Generator of parameters for constructor by column.
*/
#define _DECLARE_VIEW_CONSTRUCTION_BYCOLUMN_PARAMETERS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, DATA) \
(DATA typename BOOST_PP_CAT(Metadata::ParametersTypeOf_, LOCAL_NAME)::TupleOrPointerType LOCAL_NAME)
#define _DECLARE_VIEW_CONSTRUCTION_BYCOLUMN_PARAMETERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND( \
_DECLARE_VIEW_CONSTRUCTION_BYCOLUMN_PARAMETERS_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Generator of member initialization from constructor.
* We use a lambda with auto return type to handle multiple possible return types.
*/
// clang-format off
#define _DECLARE_VIEW_MEMBER_INITIALIZERS_IMPL(LAYOUT, MEMBER, NAME) \
(BOOST_PP_CAT(NAME, Parameters_)([&]() -> auto { \
auto params = LAYOUT.metadata().BOOST_PP_CAT(parametersOf_, MEMBER)(); \
if constexpr (alignmentEnforcement == AlignmentEnforcement::enforced) \
if (reinterpret_cast<intptr_t>(params.addr_) % alignment) \
throw std::runtime_error("In constructor by layout: misaligned column: " #NAME); \
return params; \
}()))
// clang-format on
#define _DECLARE_VIEW_MEMBER_INITIALIZERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_INITIALIZERS_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of size computation for constructor.
* This is the per-layout part of the lambda checking they all have the same size.
*/
// clang-format off
#define _UPDATE_SIZE_OF_VIEW_IMPL(LAYOUT_TYPE, LAYOUT_NAME) \
if (set) { \
if (ret != LAYOUT_NAME.metadata().size()) \
throw std::runtime_error("In constructor by layout: different sizes from layouts."); \
} else { \
ret = LAYOUT_NAME.metadata().size(); \
set = true; \
}
// clang-format on
#define _UPDATE_SIZE_OF_VIEW(R, DATA, TYPE_NAME) BOOST_PP_EXPAND(_UPDATE_SIZE_OF_VIEW_IMPL TYPE_NAME)
/**
* Generator of member initialization from constructor.
* We use a lambda with auto return type to handle multiple possible return types.
*/
// clang-format off
#define _DECLARE_VIEW_MEMBER_INITIALIZERS_BYCOLUMN_IMPL(LAYOUT, MEMBER, NAME) \
( \
BOOST_PP_CAT(NAME, Parameters_)([&]() -> auto { \
if constexpr (alignmentEnforcement == AlignmentEnforcement::enforced) \
if (Metadata:: BOOST_PP_CAT(ParametersTypeOf_, NAME)::checkAlignment(NAME, alignment)) \
throw std::runtime_error("In constructor by column: misaligned column: " #NAME); \
return NAME; \
}()) \
)
// clang-format on
#define _DECLARE_VIEW_MEMBER_INITIALIZERS_BYCOLUMN(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_INITIALIZERS_BYCOLUMN_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of layout list.
*/
#define _DECLARE_LAYOUT_LIST_IMPL(LAYOUT, NAME) (NAME)
#define _DECLARE_LAYOUT_LIST(R, DATA, LAYOUT_MEMBER_NAME) BOOST_PP_EXPAND(_DECLARE_LAYOUT_LIST_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of view member list.
*/
#define _DECLARE_VIEW_MEMBER_LIST_IMPL(LAYOUT, MEMBER, NAME) (NAME)
#define _DECLARE_VIEW_MEMBER_LIST(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_LIST_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of view member list.
*/
#define _DECLARE_VIEW_OTHER_MEMBER_LIST_IMPL(LAYOUT, MEMBER, NAME) \
(const_cast_SoAParametersImpl(other.BOOST_PP_CAT(NAME, Parameters_)).tupleOrPointer())
#define _DECLARE_VIEW_OTHER_MEMBER_LIST(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_OTHER_MEMBER_LIST_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of member initializer for copy constructor.
*/
#define _DECLARE_VIEW_MEMBER_INITIALIZERS_FROM_OTHER_IMPL(LAYOUT, MEMBER, LOCAL_NAME, DATA) \
(BOOST_PP_CAT(MEMBER, Parameters_){DATA.BOOST_PP_CAT(MEMBER, Parameters_)})
#define _DECLARE_VIEW_MEMBER_INITIALIZERS_FROM_OTHER(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_INITIALIZERS_FROM_OTHER_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Generator of member assignment for assignment operator.
*/
#define _DECLARE_VIEW_MEMBER_ASSIGNMENT_FROM_OTHER_IMPL(LAYOUT, MEMBER, LOCAL_NAME, DATA) \
BOOST_PP_CAT(MEMBER, Parameters_) = DATA.BOOST_PP_CAT(MEMBER, Parameters_);
#define _DECLARE_VIEW_MEMBER_ASSIGNMENT_FROM_OTHER(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_MEMBER_ASSIGNMENT_FROM_OTHER_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Generator of element members initializer.
*/
#define _DECLARE_VIEW_ELEM_MEMBER_INIT_IMPL(LAYOUT, MEMBER, LOCAL_NAME, DATA) (LOCAL_NAME(DATA, LOCAL_NAME))
#define _DECLARE_VIEW_ELEM_MEMBER_INIT(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_ELEM_MEMBER_INIT_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Helper macro extracting the data type from metadata of a layout or view
*/
#define _COLUMN_TYPE(LAYOUT_NAME, LAYOUT_MEMBER) \
typename std::remove_pointer<decltype(BOOST_PP_CAT(LAYOUT_NAME, Type)()::LAYOUT_MEMBER())>::type
/**
* Generator of parameters for (non-const) element subclass (expanded comma separated).
*/
#define _DECLARE_VIEW_ELEMENT_VALUE_ARG_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, DATA) \
(DATA typename BOOST_PP_CAT(Metadata::ParametersTypeOf_, LOCAL_NAME) LOCAL_NAME)
#define _DECLARE_VIEW_ELEMENT_VALUE_ARG(R, DATA, LAYOUT_MEMBER_NAME) \
_DECLARE_VIEW_ELEMENT_VALUE_ARG_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA)
/**
* Generator of parameters for (const) element subclass (expanded comma separated).
*/
#define _DECLARE_CONST_VIEW_ELEMENT_VALUE_ARG_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, DATA) \
(DATA typename BOOST_PP_CAT(Metadata::ParametersTypeOf_, LOCAL_NAME)::ConstType LOCAL_NAME)
#define _DECLARE_CONST_VIEW_ELEMENT_VALUE_ARG(R, DATA, LAYOUT_MEMBER_NAME) \
_DECLARE_CONST_VIEW_ELEMENT_VALUE_ARG_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA)
/**
* Generator of member initialization for constructor of element subclass
*/
#define _DECLARE_VIEW_CONST_ELEM_MEMBER_INIT_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, DATA) \
(BOOST_PP_CAT(LOCAL_NAME, _)(DATA, LOCAL_NAME))
/* declare AoS-like element value args for contructor; these should expand,for columns only */
#define _DECLARE_VIEW_CONST_ELEM_MEMBER_INIT(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_CONST_ELEM_MEMBER_INIT_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Declaration of the members accessors of the const element subclass
*/
// clang-format off
#define _DECLARE_VIEW_CONST_ELEMENT_ACCESSOR_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
SOA_HOST_DEVICE SOA_INLINE \
const typename SoAConstValueWithConf<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME), \
const typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>::RefToConst \
LOCAL_NAME() const { \
return BOOST_PP_CAT(LOCAL_NAME, _)(); \
}
// clang-format on
#define _DECLARE_VIEW_CONST_ELEMENT_ACCESSOR(R, DATA, LAYOUT_MEMBER_NAME) \
_DECLARE_VIEW_CONST_ELEMENT_ACCESSOR_IMPL LAYOUT_MEMBER_NAME
/**
* Declaration of the private members of the const element subclass
*/
// clang-format off
#define _DECLARE_VIEW_CONST_ELEMENT_VALUE_MEMBER_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
const cms::soa::ConstValueTraits<SoAConstValueWithConf<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME), \
typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>, \
BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)> \
BOOST_PP_CAT(LOCAL_NAME, _);
// clang-format on
#define _DECLARE_VIEW_CONST_ELEMENT_VALUE_MEMBER(R, DATA, LAYOUT_MEMBER_NAME) \
_DECLARE_VIEW_CONST_ELEMENT_VALUE_MEMBER_IMPL LAYOUT_MEMBER_NAME
/**
* Generator of the member-by-member copy operator of the element subclass.
*/
#define _DECLARE_VIEW_ELEMENT_VALUE_COPY_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
if constexpr (Metadata::BOOST_PP_CAT(ColumnTypeOf_, LOCAL_NAME) != cms::soa::SoAColumnType::scalar) \
LOCAL_NAME() = _soa_impl_other.LOCAL_NAME();
#define _DECLARE_VIEW_ELEMENT_VALUE_COPY(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_ELEMENT_VALUE_COPY_IMPL LAYOUT_MEMBER_NAME)
/**
* Declaration of the private members of the const element subclass
*/
// clang-format off
#define _DECLARE_VIEW_ELEMENT_VALUE_MEMBER_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
SoAValueWithConf<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME), \
typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)> \
LOCAL_NAME;
// clang-format on
#define _DECLARE_VIEW_ELEMENT_VALUE_MEMBER(R, DATA, LAYOUT_MEMBER_NAME) \
_DECLARE_VIEW_ELEMENT_VALUE_MEMBER_IMPL LAYOUT_MEMBER_NAME
/**
* Parameters passed to const element subclass constructor in operator[]
*/
#define _DECLARE_VIEW_CONST_ELEMENT_CONSTR_CALL_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
(BOOST_PP_CAT(LOCAL_NAME, Parameters_))
#define _DECLARE_VIEW_CONST_ELEMENT_CONSTR_CALL(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_CONST_ELEMENT_CONSTR_CALL_IMPL LAYOUT_MEMBER_NAME)
/**
* Parameters passed to element subclass constructor in operator[]
*
* The use of const_cast (inside const_cast_SoAParametersImpl) is safe because the constructor of a View binds only to
* non-const arguments.
*/
#define _DECLARE_VIEW_ELEMENT_CONSTR_CALL_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
(const_cast_SoAParametersImpl(base_type::BOOST_PP_CAT(LOCAL_NAME, Parameters_)))
#define _DECLARE_VIEW_ELEMENT_CONSTR_CALL(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_ELEMENT_CONSTR_CALL_IMPL LAYOUT_MEMBER_NAME)
/**
* Direct access to column pointer and indexed access
*/
// clang-format off
#define _DECLARE_VIEW_SOA_ACCESSOR_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
/* Column or scalar */ \
SOA_HOST_DEVICE SOA_INLINE \
typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::mutableAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>::NoParamReturnType \
LOCAL_NAME() { \
return typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::mutableAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>(const_cast_SoAParametersImpl( \
base_type:: BOOST_PP_CAT(LOCAL_NAME, Parameters_)))(); \
} \
SOA_HOST_DEVICE SOA_INLINE \
typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::mutableAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>::ParamReturnType \
LOCAL_NAME(size_type _soa_impl_index) { \
if constexpr (rangeChecking == cms::soa::RangeChecking::enabled) { \
if (_soa_impl_index >= base_type::elements_ or _soa_impl_index < 0) \
SOA_THROW_OUT_OF_RANGE("Out of range index in mutable " #LOCAL_NAME "(size_type index)") \
} \
return typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::mutableAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>(const_cast_SoAParametersImpl( \
base_type:: BOOST_PP_CAT(LOCAL_NAME, Parameters_)))(_soa_impl_index); \
}
// clang-format on
#define _DECLARE_VIEW_SOA_ACCESSOR(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_SOA_ACCESSOR_IMPL LAYOUT_MEMBER_NAME)
/**
* Direct access to column pointer (const) and indexed access.
*/
// clang-format off
#define _DECLARE_VIEW_SOA_CONST_ACCESSOR_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
/* Column or scalar */ \
SOA_HOST_DEVICE SOA_INLINE \
typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::constAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>::NoParamReturnType \
LOCAL_NAME() const { \
return typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::constAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>(BOOST_PP_CAT(LOCAL_NAME, Parameters_))(); \
} \
SOA_HOST_DEVICE SOA_INLINE \
typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::constAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>::ParamReturnType \
LOCAL_NAME(size_type _soa_impl_index) const { \
if constexpr (rangeChecking == cms::soa::RangeChecking::enabled) { \
if (_soa_impl_index >= elements_ or _soa_impl_index < 0) \
SOA_THROW_OUT_OF_RANGE("Out of range index in const " #LOCAL_NAME "(size_type index)") \
} \
return typename cms::soa::SoAAccessors<typename BOOST_PP_CAT(Metadata::TypeOf_, LOCAL_NAME)>:: \
template ColumnType<BOOST_PP_CAT(Metadata::ColumnTypeOf_, LOCAL_NAME)>::template AccessType< \
cms::soa::SoAAccessType::constAccess>::template Alignment<conditionalAlignment>:: \
template RestrictQualifier<restrictQualify>(BOOST_PP_CAT(LOCAL_NAME, Parameters_))(_soa_impl_index); \
}
// clang-format on
#define _DECLARE_VIEW_SOA_CONST_ACCESSOR(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_SOA_CONST_ACCESSOR_IMPL LAYOUT_MEMBER_NAME)
/**
* SoA class member declaration (column pointers and parameters).
*/
#define _DECLARE_VIEW_SOA_MEMBER_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, DATA) \
typename BOOST_PP_CAT(Metadata::ParametersTypeOf_, LOCAL_NAME) BOOST_PP_CAT(LOCAL_NAME, Parameters_);
#define _DECLARE_VIEW_SOA_MEMBER(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_SOA_MEMBER_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Const SoA class member declaration (column pointers and parameters).
*/
#define _DECLARE_CONST_VIEW_SOA_MEMBER_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME, DATA) \
typename BOOST_PP_CAT(Metadata::ParametersTypeOf_, LOCAL_NAME)::ConstType BOOST_PP_CAT(LOCAL_NAME, Parameters_);
#define _DECLARE_CONST_VIEW_SOA_MEMBER(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_CONST_VIEW_SOA_MEMBER_IMPL BOOST_PP_TUPLE_PUSH_BACK(LAYOUT_MEMBER_NAME, DATA))
/**
* Assign the value of the view from the values in the value_element.
*/
// clang-format off
#define _TRIVIAL_VIEW_ASSIGN_VALUE_ELEMENT_IMPL(VALUE_TYPE, CPP_TYPE, NAME) \
_SWITCH_ON_TYPE(VALUE_TYPE, \
/* Scalar (empty) */ \
, \
/* Column */ \
NAME() = _soa_impl_value.NAME; \
, \
/* Eigen column */ \
NAME() = _soa_impl_value.NAME; \
)
// clang-format on
#define _TRIVIAL_VIEW_ASSIGN_VALUE_ELEMENT(R, DATA, TYPE_NAME) _TRIVIAL_VIEW_ASSIGN_VALUE_ELEMENT_IMPL TYPE_NAME
/**
* Generator of parameters for (const) view Metarecords subclass.
*/
#define _DECLARE_CONST_VIEW_CONSTRUCTOR_COLUMNS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
(typename Metadata::BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME)::ConstType LOCAL_NAME)
#define _DECLARE_CONST_VIEW_CONSTRUCTOR_COLUMNS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_CONST_VIEW_CONSTRUCTOR_COLUMNS_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of parameters for view Metarecords subclass.
*/
#define _DECLARE_VIEW_CONSTRUCTOR_COLUMNS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
(typename Metadata::BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME) LOCAL_NAME)
#define _DECLARE_VIEW_CONSTRUCTOR_COLUMNS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_VIEW_CONSTRUCTOR_COLUMNS_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of members for (const) view Metarecords subclass.
*/
#define _DECLARE_STRUCT_CONST_DATA_MEMBER_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
typename Metadata::BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME)::ConstType BOOST_PP_CAT(LOCAL_NAME, _);
#define _DECLARE_STRUCT_CONST_DATA_MEMBER(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_STRUCT_CONST_DATA_MEMBER_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of members for view Metarecords subclass.
*/
#define _DECLARE_STRUCT_DATA_MEMBER_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
typename Metadata::BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME) BOOST_PP_CAT(LOCAL_NAME, _);
#define _DECLARE_STRUCT_DATA_MEMBER(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_DECLARE_STRUCT_DATA_MEMBER_IMPL LAYOUT_MEMBER_NAME)
/**
* Assign the value of the records to the column parameters.
*/
#define _STRUCT_ELEMENT_INITIALIZERS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
(BOOST_PP_CAT(LOCAL_NAME, _){parent_.metadata().BOOST_PP_CAT(parametersOf_, LOCAL_NAME)()})
#define _STRUCT_ELEMENT_INITIALIZERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_STRUCT_ELEMENT_INITIALIZERS_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of accessors for (const) view Metarecords subclass.
*/
#define _CONST_ACCESSORS_STRUCT_MEMBERS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
const typename Metadata::BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME)::ConstType& LOCAL_NAME() const { \
return BOOST_PP_CAT(LOCAL_NAME, _); \
}
#define _CONST_ACCESSORS_STRUCT_MEMBERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_CONST_ACCESSORS_STRUCT_MEMBERS_IMPL LAYOUT_MEMBER_NAME)
/**
* Generator of accessors for (const) view Metarecords subclass.
*/
#define _ACCESSORS_STRUCT_MEMBERS_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
const typename Metadata::BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME) & LOCAL_NAME() const { \
return BOOST_PP_CAT(LOCAL_NAME, _); \
}
#define _ACCESSORS_STRUCT_MEMBERS(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_ACCESSORS_STRUCT_MEMBERS_IMPL LAYOUT_MEMBER_NAME)
// clang-format off
#define _INITIALIZE_VIEW_PARAMETERS_AND_SIZE_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
if (not readyToSet) { \
base_type::elements_ = LOCAL_NAME.size_; \
readyToSet = true; \
} \
auto BOOST_PP_CAT(LOCAL_NAME, _tmp) = [&]() -> auto { \
if (base_type::elements_ != LOCAL_NAME.size_) \
throw std::runtime_error( \
"In constructor by column pointers: number of elements not equal for every column: " \
BOOST_PP_STRINGIZE(LOCAL_NAME)); \
if constexpr (alignmentEnforcement == AlignmentEnforcement::enforced) \
if (Metadata:: BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME)::checkAlignment(LOCAL_NAME, alignment)) \
throw std::runtime_error("In constructor by column: misaligned column: " #LOCAL_NAME); \
return LOCAL_NAME; \
}(); \
base_type::BOOST_PP_CAT(LOCAL_NAME, Parameters_) = BOOST_PP_CAT(LOCAL_NAME, _tmp); \
// clang-format on
#define _INITIALIZE_VIEW_PARAMETERS_AND_SIZE(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_INITIALIZE_VIEW_PARAMETERS_AND_SIZE_IMPL LAYOUT_MEMBER_NAME)
// clang-format off
#define _INITIALIZE_CONST_VIEW_PARAMETERS_AND_SIZE_IMPL(LAYOUT_NAME, LAYOUT_MEMBER, LOCAL_NAME) \
if (not readyToSet) { \
elements_ = LOCAL_NAME.size_; \
readyToSet = true; \
} \
auto BOOST_PP_CAT(LOCAL_NAME, _tmp) = [&]() -> auto { \
if (elements_ != LOCAL_NAME.size_) \
throw std::runtime_error( \
"In constructor by column pointers: number of elements not equal for every column: " \
BOOST_PP_STRINGIZE(LOCAL_NAME)); \
if constexpr (alignmentEnforcement == AlignmentEnforcement::enforced) \
if (Metadata:: BOOST_PP_CAT(ParametersTypeOf_, LOCAL_NAME)::checkAlignment(LOCAL_NAME, alignment)) \
throw std::runtime_error("In constructor by column: misaligned column: " #LOCAL_NAME); \
return LOCAL_NAME; \
}(); \
BOOST_PP_CAT(LOCAL_NAME, Parameters_) = BOOST_PP_CAT(LOCAL_NAME, _tmp); \
// clang-format on
#define _INITIALIZE_CONST_VIEW_PARAMETERS_AND_SIZE(R, DATA, LAYOUT_MEMBER_NAME) \
BOOST_PP_EXPAND(_INITIALIZE_CONST_VIEW_PARAMETERS_AND_SIZE_IMPL LAYOUT_MEMBER_NAME)
/* ---- MUTABLE VIEW ------------------------------------------------------------------------------------------------ */
// clang-format off
#define _GENERATE_SOA_VIEW_PART_0(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
template <CMS_SOA_BYTE_SIZE_TYPE VIEW_ALIGNMENT = cms::soa::CacheLineSize::defaultSize, \
bool VIEW_ALIGNMENT_ENFORCEMENT = cms::soa::AlignmentEnforcement::relaxed, \
bool RESTRICT_QUALIFY = cms::soa::RestrictQualify::Default, \
bool RANGE_CHECKING = cms::soa::RangeChecking::Default> \
struct VIEW : public CONST_VIEW<VIEW_ALIGNMENT, VIEW_ALIGNMENT_ENFORCEMENT, RESTRICT_QUALIFY, RANGE_CHECKING> { \
/* Declare the parametrized layouts as the default */ \
/*BOOST_PP_SEQ_CAT(_ITERATE_ON_ALL(_DECLARE_VIEW_LAYOUT_PARAMETRIZED_TEMPLATE, ~, LAYOUTS_LIST)) */ \
/* these could be moved to an external type trait to free up the symbol names */ \
using self_type = VIEW; \
using base_type = CONST_VIEW<VIEW_ALIGNMENT, VIEW_ALIGNMENT_ENFORCEMENT, RESTRICT_QUALIFY, RANGE_CHECKING>;
// clang-format on
// clang-format off
#define _GENERATE_SOA_VIEW_PART_0_NO_DEFAULTS(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
template <CMS_SOA_BYTE_SIZE_TYPE VIEW_ALIGNMENT, \
bool VIEW_ALIGNMENT_ENFORCEMENT, \
bool RESTRICT_QUALIFY, \
bool RANGE_CHECKING> \
struct VIEW : public CONST_VIEW<VIEW_ALIGNMENT, VIEW_ALIGNMENT_ENFORCEMENT, RESTRICT_QUALIFY, RANGE_CHECKING> { \
/* Declare the parametrized layouts as the default */ \
/*BOOST_PP_SEQ_CAT(_ITERATE_ON_ALL(_DECLARE_VIEW_LAYOUT_PARAMETRIZED_TEMPLATE, ~, LAYOUTS_LIST)) */ \
/* these could be moved to an external type trait to free up the symbol names */ \
using self_type = VIEW; \
using base_type = CONST_VIEW<VIEW_ALIGNMENT, VIEW_ALIGNMENT_ENFORCEMENT, RESTRICT_QUALIFY, RANGE_CHECKING>;
// clang-format on
/**
* Split of the const view definition where the parametrized template alias for the layout is defined for layout trivial view.
*/
// clang-format off
#define _GENERATE_SOA_VIEW_PART_1(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
using size_type = cms::soa::size_type; \
using byte_size_type = cms::soa::byte_size_type; \
using AlignmentEnforcement = cms::soa::AlignmentEnforcement; \
\
/* For CUDA applications, we align to the 128 bytes of the cache lines. \
* See https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#global-memory-3-0 this is still valid \
* up to compute capability 8.X. \
*/ \
constexpr static byte_size_type defaultAlignment = cms::soa::CacheLineSize::defaultSize; \
constexpr static byte_size_type alignment = VIEW_ALIGNMENT; \
constexpr static bool alignmentEnforcement = VIEW_ALIGNMENT_ENFORCEMENT; \
constexpr static byte_size_type conditionalAlignment = \
alignmentEnforcement == AlignmentEnforcement::enforced ? alignment : 0; \
constexpr static bool restrictQualify = RESTRICT_QUALIFY; \
constexpr static bool rangeChecking = RANGE_CHECKING; \
/* Those typedefs avoid having commas in macros (which is problematic) */ \
template <cms::soa::SoAColumnType COLUMN_TYPE, class C> \
using SoAValueWithConf = cms::soa::SoAValue<COLUMN_TYPE, C, conditionalAlignment, restrictQualify>; \
\
template <cms::soa::SoAColumnType COLUMN_TYPE, class C> \
using SoAConstValueWithConf = cms::soa::SoAConstValue<COLUMN_TYPE, C, conditionalAlignment, restrictQualify>; \
\
template <CMS_SOA_BYTE_SIZE_TYPE, bool, bool, bool> \
friend struct VIEW; \
\
/** \
* Helper/friend class allowing SoA introspection. \
*/ \
struct Metadata { \
friend VIEW; \
SOA_HOST_DEVICE SOA_INLINE size_type size() const { return parent_.elements_; } \
/* Alias layout or view types to name-derived identifyer to allow simpler definitions */ \
_ITERATE_ON_ALL(_DECLARE_VIEW_LAYOUT_TYPE_ALIAS, ~, LAYOUTS_LIST) \
\
/* Alias member types to name-derived identifyer to allow simpler definitions */ \
_ITERATE_ON_ALL(_DECLARE_VIEW_MEMBER_TYPE_ALIAS, const_cast_SoAParametersImpl, VALUE_LIST) \
_ITERATE_ON_ALL(_DECLARE_VIEW_MEMBER_POINTERS, ~, VALUE_LIST) \
_ITERATE_ON_ALL(_DECLARE_VIEW_MEMBER_CONST_POINTERS, ~, VALUE_LIST) \
\
/* Forbid copying to avoid const correctness evasion */ \
Metadata& operator=(const Metadata&) = delete; \
Metadata(const Metadata&) = delete; \
\
private: \
SOA_HOST_DEVICE SOA_INLINE Metadata(const VIEW& _soa_impl_parent) : parent_(_soa_impl_parent) {} \
const VIEW& parent_; \
}; \
\
friend Metadata; \
\
/** \
* Helper/friend class allowing access to size from columns. \
*/ \
struct Metarecords { \
friend VIEW; \
Metarecords(const VIEW& _soa_impl_parent) : \
parent_(_soa_impl_parent), \
_ITERATE_ON_ALL_COMMA(_STRUCT_ELEMENT_INITIALIZERS, ~, VALUE_LIST) {} \
_ITERATE_ON_ALL(_ACCESSORS_STRUCT_MEMBERS, ~, VALUE_LIST) \
private: \
const VIEW& parent_; \
_ITERATE_ON_ALL(_DECLARE_STRUCT_DATA_MEMBER, ~, VALUE_LIST) \
}; \
\
SOA_HOST_DEVICE SOA_INLINE const Metadata metadata() const { return Metadata(*this); } \
SOA_HOST_DEVICE SOA_INLINE Metadata metadata() { return Metadata(*this); } \
SOA_HOST_DEVICE SOA_INLINE const Metarecords records() const { return Metarecords(*this); } \
SOA_HOST_DEVICE SOA_INLINE Metarecords records() { return Metarecords(*this); } \
\
/* Trivial constuctor */ \
VIEW() = default; \
\
/* Constructor relying on user provided layouts or views */ \
SOA_HOST_ONLY VIEW(_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONSTRUCTION_PARAMETERS, BOOST_PP_EMPTY(), LAYOUTS_LIST)) \
: base_type{_ITERATE_ON_ALL_COMMA(_DECLARE_LAYOUT_LIST, BOOST_PP_EMPTY(), LAYOUTS_LIST)} {} \
\
/* Constructor relying on individually provided column addresses */ \
SOA_HOST_ONLY VIEW(size_type _soa_impl_elements, \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONSTRUCTION_BYCOLUMN_PARAMETERS, \
BOOST_PP_EMPTY(), \
VALUE_LIST)) \
: base_type{_soa_impl_elements, \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_MEMBER_LIST, BOOST_PP_EMPTY(), VALUE_LIST) \
} {} \
\
/* Constructor relying on individually provided column structs */ \
SOA_HOST_ONLY VIEW(_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONSTRUCTOR_COLUMNS, BOOST_PP_EMPTY(), VALUE_LIST)) { \
bool readyToSet = false; \
_ITERATE_ON_ALL(_INITIALIZE_VIEW_PARAMETERS_AND_SIZE, BOOST_PP_EMPTY(), VALUE_LIST) \
} \
\
/* Copiable */ \
VIEW(VIEW const&) = default; \
VIEW& operator=(VIEW const&) = default; \
\
/* Copy constructor for other parameters */ \
template <CMS_SOA_BYTE_SIZE_TYPE OTHER_VIEW_ALIGNMENT, \
bool OTHER_VIEW_ALIGNMENT_ENFORCEMENT, \
bool OTHER_RESTRICT_QUALIFY, \
bool OTHER_RANGE_CHECKING> \
VIEW(VIEW<OTHER_VIEW_ALIGNMENT, OTHER_VIEW_ALIGNMENT_ENFORCEMENT, OTHER_RESTRICT_QUALIFY, \
OTHER_RANGE_CHECKING> const& other): base_type{other.elements_, \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_OTHER_MEMBER_LIST, BOOST_PP_EMPTY(), VALUE_LIST) \
} {} \
/* Copy operator for other parameters */ \
template <CMS_SOA_BYTE_SIZE_TYPE OTHER_VIEW_ALIGNMENT, \
bool OTHER_VIEW_ALIGNMENT_ENFORCEMENT, \
bool OTHER_RESTRICT_QUALIFY, \
bool OTHER_RANGE_CHECKING> \
VIEW& operator=(VIEW<OTHER_VIEW_ALIGNMENT, OTHER_VIEW_ALIGNMENT_ENFORCEMENT, OTHER_RESTRICT_QUALIFY, \
OTHER_RANGE_CHECKING> const& other) { static_cast<base_type>(*this) = static_cast<base_type>(other); } \
\
/* Movable */ \
VIEW(VIEW &&) = default; \
VIEW& operator=(VIEW &&) = default; \
\
/* Trivial destuctor */ \
~VIEW() = default; \
\
/* AoS-like accessor (const) */ \
using const_element = typename base_type::const_element; \
\
using base_type::operator[]; \
\
/* AoS-like accessor (mutable) */ \
struct element { \
SOA_HOST_DEVICE SOA_INLINE \
element(size_type _soa_impl_index, /* Declare parameters */ \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_ELEMENT_VALUE_ARG, BOOST_PP_EMPTY(), VALUE_LIST)) \
: _ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_ELEM_MEMBER_INIT, _soa_impl_index, VALUE_LIST) {} \
SOA_HOST_DEVICE SOA_INLINE \
element& operator=(const element& _soa_impl_other) { \
_ITERATE_ON_ALL(_DECLARE_VIEW_ELEMENT_VALUE_COPY, ~, VALUE_LIST) \
return *this; \
} \
SOA_HOST_DEVICE SOA_INLINE \
element& operator=(const const_element& _soa_impl_other) { \
_ITERATE_ON_ALL(_DECLARE_VIEW_ELEMENT_VALUE_COPY, ~, VALUE_LIST) \
return *this; \
}
// clang-format on
// clang-format off
#define _GENERATE_SOA_VIEW_PART_2(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
_ITERATE_ON_ALL(_DECLARE_VIEW_ELEMENT_VALUE_MEMBER, ~, VALUE_LIST) \
}; \
\
SOA_HOST_DEVICE SOA_INLINE \
element operator[](size_type _soa_impl_index) { \
if constexpr (rangeChecking == cms::soa::RangeChecking::enabled) { \
if (_soa_impl_index >= base_type::elements_ or _soa_impl_index < 0) \
SOA_THROW_OUT_OF_RANGE("Out of range index in " #VIEW "::operator[]") \
} \
return element{_soa_impl_index, _ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_ELEMENT_CONSTR_CALL, ~, VALUE_LIST)}; \
} \
\
/* inherit const accessors from ConstView */ \
\
/* non-const accessors */ \
_ITERATE_ON_ALL(_DECLARE_VIEW_SOA_ACCESSOR, ~, VALUE_LIST) \
\
/* dump the SoA internal structure */ \
template <typename T> \
SOA_HOST_ONLY friend void dump(); \
};
// clang-format on
/* ---- CONST VIEW -------------------------------------------------------------------------------------------------- */
// clang-format off
#define _GENERATE_SOA_CONST_VIEW_PART_0(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
template <CMS_SOA_BYTE_SIZE_TYPE VIEW_ALIGNMENT = cms::soa::CacheLineSize::defaultSize, \
bool VIEW_ALIGNMENT_ENFORCEMENT = cms::soa::AlignmentEnforcement::relaxed, \
bool RESTRICT_QUALIFY = cms::soa::RestrictQualify::Default, \
bool RANGE_CHECKING = cms::soa::RangeChecking::Default> \
struct CONST_VIEW { \
/* these could be moved to an external type trait to free up the symbol names */ \
using self_type = CONST_VIEW;
// clang-format on
// clang-format off
#define _GENERATE_SOA_CONST_VIEW_PART_0_NO_DEFAULTS(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
template <CMS_SOA_BYTE_SIZE_TYPE VIEW_ALIGNMENT, \
bool VIEW_ALIGNMENT_ENFORCEMENT, \
bool RESTRICT_QUALIFY, \
bool RANGE_CHECKING> \
struct CONST_VIEW { \
/* these could be moved to an external type trait to free up the symbol names */ \
using self_type = CONST_VIEW;
// clang-format on
/**
* Split of the const view definition where the parametrized template alias for the layout is defined for layout trivial view.
*/
// clang-format off
#define _GENERATE_SOA_CONST_VIEW_PART_1(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
using size_type = cms::soa::size_type; \
using byte_size_type = cms::soa::byte_size_type; \
using AlignmentEnforcement = cms::soa::AlignmentEnforcement; \
\
template <CMS_SOA_BYTE_SIZE_TYPE, bool, bool, bool> \
friend struct VIEW; \
\
template <CMS_SOA_BYTE_SIZE_TYPE, bool, bool, bool> \
friend struct CONST_VIEW; \
\
/* For CUDA applications, we align to the 128 bytes of the cache lines. \
* See https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#global-memory-3-0 this is still valid \
* up to compute capability 8.X. \
*/ \
constexpr static byte_size_type defaultAlignment = cms::soa::CacheLineSize::defaultSize; \
constexpr static byte_size_type alignment = VIEW_ALIGNMENT; \
constexpr static bool alignmentEnforcement = VIEW_ALIGNMENT_ENFORCEMENT; \
constexpr static byte_size_type conditionalAlignment = \
alignmentEnforcement == AlignmentEnforcement::enforced ? alignment : 0; \
constexpr static bool restrictQualify = RESTRICT_QUALIFY; \
constexpr static bool rangeChecking = RANGE_CHECKING; \
/* Those typedefs avoid having commas in macros (which is problematic) */ \
template <cms::soa::SoAColumnType COLUMN_TYPE, class C> \
using SoAValueWithConf = cms::soa::SoAValue<COLUMN_TYPE, C, conditionalAlignment, restrictQualify>; \
\
template <cms::soa::SoAColumnType COLUMN_TYPE, class C> \
using SoAConstValueWithConf = cms::soa::SoAConstValue<COLUMN_TYPE, C, conditionalAlignment, restrictQualify>; \
\
/** \
* Helper/friend class allowing SoA introspection. \
*/ \
struct Metadata { \
friend CONST_VIEW; \
SOA_HOST_DEVICE SOA_INLINE size_type size() const { return parent_.elements_; } \
/* Alias layout or view types to name-derived identifyer to allow simpler definitions */ \
_ITERATE_ON_ALL(_DECLARE_VIEW_LAYOUT_TYPE_ALIAS, ~, LAYOUTS_LIST) \
\
/* Alias member types to name-derived identifyer to allow simpler definitions */ \
_ITERATE_ON_ALL(_DECLARE_VIEW_MEMBER_TYPE_ALIAS, BOOST_PP_EMPTY(), VALUE_LIST) \
_ITERATE_ON_ALL(_DECLARE_VIEW_MEMBER_CONST_POINTERS, ~, VALUE_LIST) \
\
/* Forbid copying to avoid const correctness evasion */ \
Metadata& operator=(const Metadata&) = delete; \
Metadata(const Metadata&) = delete; \
\
private: \
SOA_HOST_DEVICE SOA_INLINE Metadata(const CONST_VIEW& _soa_impl_parent) : parent_(_soa_impl_parent) {} \
const CONST_VIEW& parent_; \
}; \
\
friend Metadata; \
\
/** \
* Helper/friend class allowing access to size from columns. \
*/ \
struct Metarecords { \
friend CONST_VIEW; \
Metarecords(const CONST_VIEW& _soa_impl_parent) : \
parent_(_soa_impl_parent), \
_ITERATE_ON_ALL_COMMA(_STRUCT_ELEMENT_INITIALIZERS, ~, VALUE_LIST) {} \
_ITERATE_ON_ALL(_CONST_ACCESSORS_STRUCT_MEMBERS, ~, VALUE_LIST) \
private: \
const CONST_VIEW& parent_; \
_ITERATE_ON_ALL(_DECLARE_STRUCT_CONST_DATA_MEMBER, ~, VALUE_LIST) \
}; \
SOA_HOST_DEVICE SOA_INLINE const Metadata metadata() const { return Metadata(*this); } \
SOA_HOST_DEVICE SOA_INLINE const Metarecords records() const { return Metarecords(*this); } \
\
/* Trivial constuctor */ \
CONST_VIEW() = default; \
\
/* Constructor relying on user provided layouts or views */ \
SOA_HOST_ONLY CONST_VIEW(_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONSTRUCTION_PARAMETERS, const, LAYOUTS_LIST)) \
: elements_([&]() -> size_type { \
bool set = false; \
size_type ret = 0; \
_ITERATE_ON_ALL(_UPDATE_SIZE_OF_VIEW, BOOST_PP_EMPTY(), LAYOUTS_LIST) \
return ret; \
}()), \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_MEMBER_INITIALIZERS, ~, VALUE_LIST) {} \
\
/* Constructor relying on individually provided column addresses */ \
SOA_HOST_ONLY CONST_VIEW(size_type _soa_impl_elements, \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONSTRUCTION_BYCOLUMN_PARAMETERS, const, VALUE_LIST)) \
: elements_(_soa_impl_elements), \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_MEMBER_INITIALIZERS_BYCOLUMN, ~, VALUE_LIST) {} \
\
/* Constructor relying on individually provided column structs */ \
SOA_HOST_ONLY CONST_VIEW(_ITERATE_ON_ALL_COMMA( \
_DECLARE_CONST_VIEW_CONSTRUCTOR_COLUMNS, BOOST_PP_EMPTY(), VALUE_LIST)) { \
bool readyToSet = false; \
_ITERATE_ON_ALL(_INITIALIZE_CONST_VIEW_PARAMETERS_AND_SIZE, BOOST_PP_EMPTY(), VALUE_LIST) \
} \
\
/* Copiable */ \
CONST_VIEW(CONST_VIEW const&) = default; \
CONST_VIEW& operator=(CONST_VIEW const&) = default; \
\
/* Copy constructor for other parameters */ \
template <CMS_SOA_BYTE_SIZE_TYPE OTHER_VIEW_ALIGNMENT, \
bool OTHER_VIEW_ALIGNMENT_ENFORCEMENT, \
bool OTHER_RESTRICT_QUALIFY, \
bool OTHER_RANGE_CHECKING> \
CONST_VIEW(CONST_VIEW<OTHER_VIEW_ALIGNMENT, OTHER_VIEW_ALIGNMENT_ENFORCEMENT, OTHER_RESTRICT_QUALIFY, \
OTHER_RANGE_CHECKING> const& other): CONST_VIEW{other.elements_, \
_ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_OTHER_MEMBER_LIST, BOOST_PP_EMPTY(), VALUE_LIST) \
} {} \
/* Copy operator for other parameters */ \
template <CMS_SOA_BYTE_SIZE_TYPE OTHER_VIEW_ALIGNMENT, \
bool OTHER_VIEW_ALIGNMENT_ENFORCEMENT, \
bool OTHER_RESTRICT_QUALIFY, \
bool OTHER_RANGE_CHECKING> \
CONST_VIEW& operator=(CONST_VIEW<OTHER_VIEW_ALIGNMENT, OTHER_VIEW_ALIGNMENT_ENFORCEMENT, OTHER_RESTRICT_QUALIFY, \
OTHER_RANGE_CHECKING> const& other) { *this = other; } \
\
/* Movable */ \
CONST_VIEW(CONST_VIEW &&) = default; \
CONST_VIEW& operator=(CONST_VIEW &&) = default; \
\
/* Trivial destuctor */ \
~CONST_VIEW() = default; \
\
/* AoS-like accessor (const) */ \
struct const_element { \
SOA_HOST_DEVICE SOA_INLINE \
const_element(size_type _soa_impl_index, /* Declare parameters */ \
_ITERATE_ON_ALL_COMMA(_DECLARE_CONST_VIEW_ELEMENT_VALUE_ARG, const, VALUE_LIST)) \
: _ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONST_ELEM_MEMBER_INIT, _soa_impl_index, VALUE_LIST) {} \
_ITERATE_ON_ALL(_DECLARE_VIEW_CONST_ELEMENT_ACCESSOR, ~, VALUE_LIST) \
\
private: \
_ITERATE_ON_ALL(_DECLARE_VIEW_CONST_ELEMENT_VALUE_MEMBER, ~, VALUE_LIST) \
}; \
\
SOA_HOST_DEVICE SOA_INLINE \
const_element operator[](size_type _soa_impl_index) const { \
if constexpr (rangeChecking == cms::soa::RangeChecking::enabled) { \
if (_soa_impl_index >= elements_ or _soa_impl_index < 0) \
SOA_THROW_OUT_OF_RANGE("Out of range index in " #CONST_VIEW "::operator[]") \
} \
return const_element{ \
_soa_impl_index, _ITERATE_ON_ALL_COMMA(_DECLARE_VIEW_CONST_ELEMENT_CONSTR_CALL, ~, VALUE_LIST) \
}; \
} \
\
/* const accessors */ \
_ITERATE_ON_ALL(_DECLARE_VIEW_SOA_CONST_ACCESSOR, ~, VALUE_LIST) \
\
/* dump the SoA internal structure */ \
template <typename T> \
SOA_HOST_ONLY friend void dump(); \
\
private: \
size_type elements_ = 0; \
_ITERATE_ON_ALL(_DECLARE_CONST_VIEW_SOA_MEMBER, const, VALUE_LIST) \
};
// clang-format on
// clang-format off
// MAJOR caveat: in order to propagate the LAYOUTS_LIST and VALUE_LIST
#define _GENERATE_SOA_CONST_VIEW(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
_GENERATE_SOA_CONST_VIEW_PART_0(CONST_VIEW, VIEW, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
_GENERATE_SOA_CONST_VIEW_PART_1(CONST_VIEW, VIEW, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST))
#define GENERATE_SOA_CONST_VIEW(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
_GENERATE_SOA_CONST_VIEW(CONST_VIEW, BOOST_PP_CAT(CONST_VIEW, Unused_), \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST))
#define _GENERATE_SOA_TRIVIAL_CONST_VIEW(CLASS, LAYOUTS_LIST, VALUE_LIST) \
_GENERATE_SOA_CONST_VIEW_PART_0_NO_DEFAULTS(ConstViewTemplateFreeParams, ViewTemplateFreeParams, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
using BOOST_PP_CAT(CLASS, _parametrized) = CLASS<VIEW_ALIGNMENT, VIEW_ALIGNMENT_ENFORCEMENT>; \
_GENERATE_SOA_CONST_VIEW_PART_1(ConstViewTemplateFreeParams, ViewTemplateFreeParams, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST))
#define _GENERATE_SOA_VIEW(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
_GENERATE_SOA_VIEW_PART_0(CONST_VIEW, VIEW, SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
_GENERATE_SOA_VIEW_PART_1(CONST_VIEW, VIEW, SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
_GENERATE_SOA_VIEW_PART_2(CONST_VIEW, VIEW, SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST))
#define GENERATE_SOA_VIEW(CONST_VIEW, VIEW, LAYOUTS_LIST, VALUE_LIST) \
_GENERATE_SOA_CONST_VIEW(CONST_VIEW, VIEW, SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
_GENERATE_SOA_VIEW(CONST_VIEW, VIEW, SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST))
#define _GENERATE_SOA_TRIVIAL_VIEW(CLASS, LAYOUTS_LIST, VALUE_LIST, ...) \
_GENERATE_SOA_VIEW_PART_0_NO_DEFAULTS(ConstViewTemplateFreeParams, ViewTemplateFreeParams, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
using BOOST_PP_CAT(CLASS, _parametrized) = CLASS<VIEW_ALIGNMENT, VIEW_ALIGNMENT_ENFORCEMENT>; \
_GENERATE_SOA_VIEW_PART_1(ConstViewTemplateFreeParams, ViewTemplateFreeParams, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST)) \
\
/* Extra operator=() for mutable element to emulate the aggregate initialisation syntax */ \
SOA_HOST_DEVICE SOA_INLINE constexpr element & operator=(const typename \
BOOST_PP_CAT(CLASS, _parametrized)::Metadata::value_element _soa_impl_value) { \
_ITERATE_ON_ALL(_TRIVIAL_VIEW_ASSIGN_VALUE_ELEMENT, ~, __VA_ARGS__) \
return *this; \
} \
\
_GENERATE_SOA_VIEW_PART_2(ConstViewTemplateFreeParams, ViewTemplateFreeParams, \
SOA_VIEW_LAYOUT_LIST(LAYOUTS_LIST), SOA_VIEW_VALUE_LIST(VALUE_LIST))
// clang-format on
/**
* Helper macro turning layout field declaration into view field declaration.
*/
#define _VIEW_FIELD_FROM_LAYOUT_IMPL(VALUE_TYPE, CPP_TYPE, NAME, DATA) (DATA, NAME, NAME)
#define _VIEW_FIELD_FROM_LAYOUT(R, DATA, VALUE_TYPE_NAME) \
BOOST_PP_EXPAND((_VIEW_FIELD_FROM_LAYOUT_IMPL BOOST_PP_TUPLE_PUSH_BACK(VALUE_TYPE_NAME, DATA)))
#endif // DataFormats_SoATemplate_interface_SoAView_h
|