Skip to content

Commit 4dcdba0

Browse files
committed
Add docs for ParentCG
1 parent 144be85 commit 4dcdba0

File tree

10 files changed

+79
-0
lines changed

10 files changed

+79
-0
lines changed

include/cuco/detail/open_addressing/open_addressing_ref_impl.cuh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,7 @@ class open_addressing_ref_impl {
419419
* @brief Inserts an element.
420420
*
421421
* @tparam Value Input type which is convertible to 'value_type'
422+
* @tparam ParentCG Type of parent Cooperative Group
422423
*
423424
* @param group The Cooperative Group used to perform group insert
424425
* @param value The element to insert
@@ -578,6 +579,7 @@ class open_addressing_ref_impl {
578579
* not.
579580
*
580581
* @tparam Value Input type which is convertible to 'value_type'
582+
* @tparam ParentCG Type of parent Cooperative Group
581583
*
582584
* @param group The Cooperative Group used to perform group insert_and_find
583585
* @param value The element to insert
@@ -721,6 +723,7 @@ class open_addressing_ref_impl {
721723
* @brief Erases an element.
722724
*
723725
* @tparam ProbeKey Input type which is convertible to 'key_type'
726+
* @tparam ParentCG Type of parent Cooperative Group
724727
*
725728
* @param group The Cooperative Group used to perform group erase
726729
* @param value The element to erase
@@ -818,6 +821,7 @@ class open_addressing_ref_impl {
818821
* false.
819822
*
820823
* @tparam ProbeKey Probe key type
824+
* @tparam ParentCG Type of parent Cooperative Group
821825
*
822826
* @param group The Cooperative Group used to perform group contains
823827
* @param key The key to search for
@@ -902,6 +906,7 @@ class open_addressing_ref_impl {
902906
* `key`. If no such element exists, returns `end()`.
903907
*
904908
* @tparam ProbeKey Probe key type
909+
* @tparam ParentCG Type of parent Cooperative Group
905910
*
906911
* @param group The Cooperative Group used to perform this operation
907912
* @param key The key to search for
@@ -999,6 +1004,7 @@ class open_addressing_ref_impl {
9991004
* @brief Counts the occurrence of a given key contained in the container
10001005
*
10011006
* @tparam ProbeKey Probe key type
1007+
* @tparam ParentCG Type of parent Cooperative Group
10021008
*
10031009
* @param group The Cooperative Group used to perform group count
10041010
* @param key The key to count for
@@ -1406,6 +1412,7 @@ class open_addressing_ref_impl {
14061412
*
14071413
* @tparam ProbeKey Probe key type
14081414
* @tparam CallbackOp Type of unary callback function object
1415+
* @tparam ParentCG Type of parent Cooperative Group
14091416
*
14101417
* @param group The Cooperative Group used to perform this operation
14111418
* @param key The key to search for
@@ -1469,6 +1476,7 @@ class open_addressing_ref_impl {
14691476
* @tparam ProbeKey Probe key type
14701477
* @tparam CallbackOp Type of unary callback function object
14711478
* @tparam SyncOp Type of function object which accepts the current `group` object
1479+
* @tparam ParentCG Type of parent Cooperative Group
14721480
*
14731481
* @param group The Cooperative Group used to perform this operation
14741482
* @param key The key to search for

include/cuco/detail/probe_sequence_impl.cuh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ class linear_probing_impl
201201
* If vector-load is enabled, the return slot is always even to avoid illegal memory access.
202202
*
203203
* @tparam ProbeKey Probe key type
204+
* @tparam ParentCG Type of parent Cooperative Group
204205
*
205206
* @param g the Cooperative Group for which the initial slot is needed
206207
* @param k The key to get the slot for
@@ -219,6 +220,7 @@ class linear_probing_impl
219220
* If vector-load is enabled, the return slot is always even to avoid illegal memory access.
220221
*
221222
* @tparam ProbeKey Probe key type
223+
* @tparam ParentCG Type of parent Cooperative Group
222224
*
223225
* @param g the Cooperative Group for which the initial slot is needed
224226
* @param k The key to get the slot for
@@ -355,6 +357,7 @@ class double_hashing_impl
355357
* to avoid illegal memory access.
356358
*
357359
* @tparam ProbeKey Probe key type
360+
* @tparam ParentCG Type of parent Cooperative Group
358361
*
359362
* @param g the Cooperative Group for which the initial slot is needed
360363
* @param k The key to get the slot for
@@ -374,6 +377,7 @@ class double_hashing_impl
374377
* to avoid illegal memory access.
375378
*
376379
* @tparam ProbeKey Probe key type
380+
* @tparam ParentCG Type of parent Cooperative Group
377381
*
378382
* @param g the Cooperative Group for which the initial slot is needed
379383
* @param k The key to get the slot for

include/cuco/detail/static_map/static_map_ref.inl

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,7 @@ class operator_impl<
459459
* @brief Inserts an element.
460460
*
461461
* @tparam Value Input type which is convertible to 'value_type'
462+
* @tparam ParentCG Type of parent Cooperative Group
462463
*
463464
* @param group The Cooperative Group used to perform group insert
464465
* @param value The element to insert
@@ -552,6 +553,7 @@ class operator_impl<
552553
* to the mapped_type corresponding to the key `k`.
553554
*
554555
* @tparam Value Input type which is convertible to 'value_type'
556+
* @tparam ParentCG Type of parent Cooperative Group
555557
*
556558
* @param group The Cooperative Group used to perform group insert
557559
* @param value The element to insert
@@ -744,6 +746,7 @@ class operator_impl<
744746
* @tparam Op Callable type which is used as apply operation and can be
745747
* called with arguments as Op(cuda::atomic_ref<T, Scope>, T). Op strictly must
746748
* have this signature to atomically apply the operation.
749+
* @tparam ParentCG Type of parent Cooperative Group
747750
*
748751
* @param group The Cooperative Group used to perform group insert
749752
* @param value The element to insert
@@ -776,6 +779,7 @@ class operator_impl<
776779
* @tparam Op Callable type which is used as apply operation and can be
777780
* called with arguments as Op(cuda::atomic_ref<T, Scope>, T). Op strictly must
778781
* have this signature to atomically apply the operation.
782+
* @tparam ParentCG Type of parent Cooperative Group
779783
*
780784
* @param group The Cooperative Group used to perform group insert
781785
* @param value The element to insert
@@ -836,6 +840,7 @@ class operator_impl<
836840
* @tparam Op Callable type which is used as apply operation and can be
837841
* called with arguments as Op(cuda::atomic_ref<T, Scope>, T). Op strictly must
838842
* have this signature to atomically apply the operation.
843+
* @tparam ParentCG Type of parent Cooperative Group
839844
*
840845
* @param group The Cooperative Group used to perform group insert
841846
* @param value The element to insert
@@ -944,6 +949,7 @@ class operator_impl<
944949
* @tparam Op Callable type which is used as apply operation and can be
945950
* called with arguments as Op(cuda::atomic_ref<T, Scope>, T). Op strictly must
946951
* have this signature to atomically apply the operation.
952+
* @tparam ParentCG Type of parent Cooperative Group
947953
*
948954
* @param group The Cooperative Group used to perform group insert
949955
* @param value The element to insert
@@ -1141,6 +1147,7 @@ class operator_impl<
11411147
* not.
11421148
*
11431149
* @tparam Value Input type which is convertible to 'value_type'
1150+
* @tparam ParentCG Type of parent Cooperative Group
11441151
*
11451152
* @param group The Cooperative Group used to perform group insert_and_find
11461153
* @param value The element to insert
@@ -1196,6 +1203,7 @@ class operator_impl<
11961203
* @brief Erases an element.
11971204
*
11981205
* @tparam ProbeKey Input key type which is convertible to 'key_type'
1206+
* @tparam ParentCG Type of parent Cooperative Group
11991207
*
12001208
* @param group The Cooperative Group used to perform group insert
12011209
* @param key The element to erase
@@ -1257,6 +1265,7 @@ class operator_impl<
12571265
* true. Otherwise, returns false.
12581266
*
12591267
* @tparam ProbeKey Probe key type
1268+
* @tparam ParentCG Type of parent Cooperative Group
12601269
*
12611270
* @param group The Cooperative Group used to perform group contains
12621271
* @param key The key to search for
@@ -1321,6 +1330,7 @@ class operator_impl<
13211330
* `key`. If no such element exists, returns `end()`.
13221331
*
13231332
* @tparam ProbeKey Probe key type
1333+
* @tparam ParentCG Type of parent Cooperative Group
13241334
*
13251335
* @param group The Cooperative Group used to perform this operation
13261336
* @param key The key to search for
@@ -1391,6 +1401,7 @@ class operator_impl<
13911401
*
13921402
* @tparam ProbeKey Probe key type
13931403
* @tparam CallbackOp Type of unary callback function object
1404+
* @tparam ParentCG Type of parent Cooperative Group
13941405
*
13951406
* @param group The Cooperative Group used to perform this operation
13961407
* @param key The key to search for
@@ -1447,6 +1458,7 @@ class operator_impl<
14471458
* @brief Counts the occurrence of a given key contained in map
14481459
*
14491460
* @tparam ProbeKey Probe key type
1461+
* @tparam ParentCG Type of parent Cooperative Group
14501462
*
14511463
* @param group The Cooperative Group used to perform group count
14521464
* @param key The key to count for

include/cuco/detail/static_multimap/device_view_impl.inl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ class static_multimap<Key, Value, Scope, Allocator, ProbeSequence>::device_view_
7272
* To be used for Cooperative Group based probing.
7373
*
7474
* @tparam ProbeKey Probe key type
75+
* @tparam ParentCG Type of parent Cooperative Group
7576
*
7677
* @param g the Cooperative Group for which the initial slot is needed
7778
* @param k The key to get the slot for
@@ -91,6 +92,7 @@ class static_multimap<Key, Value, Scope, Allocator, ProbeSequence>::device_view_
9192
* To be used for Cooperative Group based probing.
9293
*
9394
* @tparam ProbeKey Probe key type
95+
* @tparam ParentCG Type of parent Cooperative Group
9496
*
9597
* @param g the Cooperative Group for which the initial slot is needed
9698
* @param k The key to get the slot for
@@ -578,6 +580,7 @@ class static_multimap<Key, Value, Scope, Allocator, ProbeSequence>::device_view_
578580
* @tparam uses_vector_load Boolean flag indicating whether vector loads are used
579581
* @tparam ProbeT Probe data type
580582
* @tparam Equal Binary callable type
583+
* @tparam ParentCG Type of parent Cooperative Group
581584
*
582585
* @param g The Cooperative Group used to perform the contains operation
583586
* @param element The probe element to search for
@@ -648,6 +651,7 @@ class static_multimap<Key, Value, Scope, Allocator, ProbeSequence>::device_view_
648651
* @tparam uses_vector_load Boolean flag indicating whether vector loads are used
649652
* @tparam ProbeT Probe data type
650653
* @tparam Equal Binary callable type
654+
* @tparam ParentCG Type of parent Cooperative Group
651655
*
652656
* @param g The Cooperative Group used to perform the contains operation
653657
* @param element The probe element to search for

include/cuco/detail/static_multimap/static_multimap_ref.inl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,7 @@ class operator_impl<
462462
* @brief Inserts an element.
463463
*
464464
* @tparam Value Input type which is convertible to 'value_type'
465+
* @tparam ParentCG Type of parent Cooperative Group
465466
*
466467
* @param group The Cooperative Group used to perform group insert
467468
* @param value The element to insert
@@ -528,6 +529,7 @@ class operator_impl<
528529
* true. Otherwise, returns false.
529530
*
530531
* @tparam ProbeKey Probe key type
532+
* @tparam ParentCG Type of parent Cooperative Group
531533
*
532534
* @param group The Cooperative Group used to perform group contains
533535
* @param key The key to search for
@@ -597,6 +599,7 @@ class operator_impl<
597599
*
598600
* @tparam ProbeKey Probe key type
599601
* @tparam CallbackOp Unary callback functor or device lambda
602+
* @tparam ParentCG Type of parent Cooperative Group
600603
*
601604
* @param group The Cooperative Group used to perform this operation
602605
* @param key The key to search for
@@ -634,6 +637,7 @@ class operator_impl<
634637
* @tparam ProbeKey Probe key type
635638
* @tparam CallbackOp Unary callback functor or device lambda
636639
* @tparam SyncOp Functor or device lambda which accepts the current `group` object
640+
* @tparam ParentCG Type of parent Cooperative Group
637641
*
638642
* @param group The Cooperative Group used to perform this operation
639643
* @param key The key to search for
@@ -702,6 +706,7 @@ class operator_impl<
702706
* `key`. If no such element exists, returns `end()`.
703707
*
704708
* @tparam ProbeKey Probe key type
709+
* @tparam ParentCG Type of parent Cooperative Group
705710
*
706711
* @param group The Cooperative Group used to perform this operation
707712
* @param key The key to search for
@@ -759,6 +764,7 @@ class operator_impl<
759764
* @brief Counts the occurrence of a given key contained in multimap
760765
*
761766
* @tparam ProbeKey Probe key type
767+
* @tparam ParentCG Type of parent Cooperative Group
762768
*
763769
* @param group The Cooperative Group used to perform group count
764770
* @param key The key to count for

include/cuco/detail/static_multiset/static_multiset_ref.inl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,7 @@ class operator_impl<
401401
* @brief Inserts an element.
402402
*
403403
* @tparam Value Input type which is convertible to 'value_type'
404+
* @tparam ParentCG Type of parent Cooperative Group
404405
*
405406
* @param group The Cooperative Group used to perform group insert
406407
* @param value The element to insert
@@ -459,6 +460,7 @@ class operator_impl<
459460
* @brief Indicates whether the probe key `key` was inserted into the container.
460461
*
461462
* @tparam ProbeKey Probe key type
463+
* @tparam ParentCG Type of parent Cooperative Group
462464
*
463465
* @param group The Cooperative Group used to perform group contains
464466
* @param key The key to search for
@@ -523,6 +525,7 @@ class operator_impl<
523525
* `key`. If no such element exists, returns `end()`.
524526
*
525527
* @tparam ProbeKey Probe key type
528+
* @tparam ParentCG Type of parent Cooperative Group
526529
*
527530
* @param group The Cooperative Group used to perform this operation
528531
* @param key The key to search for
@@ -708,6 +711,7 @@ class operator_impl<
708711
*
709712
* @tparam ProbeKey Probe key type
710713
* @tparam CallbackOp Unary callback functor or device lambda
714+
* @tparam ParentCG Type of parent Cooperative Group
711715
*
712716
* @param group The Cooperative Group used to perform this operation
713717
* @param key The key to search for
@@ -745,6 +749,7 @@ class operator_impl<
745749
* @tparam ProbeKey Probe key type
746750
* @tparam CallbackOp Unary callback functor or device lambda
747751
* @tparam SyncOp Functor or device lambda which accepts the current `group` object
752+
* @tparam ParentCG Type of parent Cooperative Group
748753
*
749754
* @param group The Cooperative Group used to perform this operation
750755
* @param key The key to search for
@@ -804,6 +809,7 @@ class operator_impl<
804809
* @brief Counts the occurrence of a given key contained in multiset
805810
*
806811
* @tparam ProbeKey Probe key type
812+
* @tparam ParentCG Type of parent Cooperative Group
807813
*
808814
* @param group The Cooperative Group used to perform group count
809815
* @param key The key to count for

include/cuco/detail/static_set/static_set_ref.inl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,7 @@ class operator_impl<op::insert_tag,
398398
* @brief Inserts an element.
399399
*
400400
* @tparam Value Input type which is convertible to 'value_type'
401+
* @tparam ParentCG Type of parent Cooperative Group
401402
*
402403
* @param group The Cooperative Group used to perform group insert
403404
* @param value The element to insert
@@ -465,6 +466,7 @@ class operator_impl<op::insert_and_find_tag,
465466
* not.
466467
*
467468
* @tparam Value Input type which is convertible to 'value_type'
469+
* @tparam ParentCG Type of parent Cooperative Group
468470
*
469471
* @param group The Cooperative Group used to perform group insert_and_find
470472
* @param value The element to insert
@@ -518,6 +520,7 @@ class operator_impl<op::erase_tag,
518520
* @brief Erases an element.
519521
*
520522
* @tparam ProbeKey Input type which is convertible to 'key_type'
523+
* @tparam ParentCG Type of parent Cooperative Group
521524
*
522525
* @param group The Cooperative Group used to perform group erase
523526
* @param value The element to erase
@@ -576,6 +579,7 @@ class operator_impl<op::contains_tag,
576579
* false.
577580
*
578581
* @tparam ProbeKey Probe key type
582+
* @tparam ParentCG Type of parent Cooperative Group
579583
*
580584
* @param group The Cooperative Group used to perform group contains
581585
* @param key The key to search for
@@ -638,6 +642,7 @@ class operator_impl<op::find_tag,
638642
* `key`. If no such element exists, returns `end()`.
639643
*
640644
* @tparam ProbeKey Probe key type
645+
* @tparam ParentCG Type of parent Cooperative Group
641646
*
642647
* @param group The Cooperative Group used to perform this operation
643648
* @param key The key to search for
@@ -706,6 +711,7 @@ class operator_impl<op::for_each_tag,
706711
*
707712
* @tparam ProbeKey Probe key type
708713
* @tparam CallbackOp Type of unary callback function object
714+
* @tparam ParentCG Type of parent Cooperative Group
709715
*
710716
* @param group The Cooperative Group used to perform this operation
711717
* @param key The key to search for
@@ -760,6 +766,7 @@ class operator_impl<op::count_tag,
760766
* @brief Counts the occurrence of a given key contained in set
761767
*
762768
* @tparam ProbeKey Probe key type
769+
* @tparam ParentCG Type of parent Cooperative Group
763770
*
764771
* @param group The Cooperative Group used to perform group count
765772
* @param key The key to count for

0 commit comments

Comments
 (0)