Fix various typos in CUB documentation and comments. (#1933)

NVIDIA · Jul 3, 2024 · 07a0564 · 07a0564
1 parent e58c7e7
commit 07a0564
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 7 deletions.
diff --git a/cub/cub/agent/agent_reduce_by_key.cuh b/cub/cub/agent/agent_reduce_by_key.cuh
@@ -146,6 +146,9 @@ struct AgentReduceByKeyPolicy
  *
  * @tparam OffsetT
  *   Signed integer type for global offsets
+ *
+ * @tparam AccumT
+ *   The type of intermediate accumulator (according to P2322R6)
  */
 template <typename AgentReduceByKeyPolicyT,
           typename KeysInputIteratorT,

diff --git a/cub/cub/agent/agent_scan.cuh b/cub/cub/agent/agent_scan.cuh
@@ -135,6 +135,8 @@ struct AgentScanPolicy : ScalingType
  * @tparam OffsetT
  *   Signed integer type for global offsets
  *
+ * @tparam AccumT
+ *   The type of intermediate accumulator (according to P2322R6)
  */
 template <typename AgentScanPolicyT,
           typename InputIteratorT,

diff --git a/cub/cub/agent/agent_scan_by_key.cuh b/cub/cub/agent/agent_scan_by_key.cuh
@@ -122,6 +122,8 @@ struct AgentScanByKeyPolicy
  * @tparam OffsetT
  *   Signed integer type for global offsets
  *
+ * @tparam AccumT
+ *   The type of intermediate accumulator (according to P2322R6)
  */
 template <typename AgentScanByKeyPolicyT,
           typename KeysInputIteratorT,
@@ -235,7 +237,7 @@ struct AgentScanByKey
     SizeValuePairT (&scan_items)[ITEMS_PER_THREAD],
     SizeValuePairT& tile_aggregate,
     TilePrefixCallbackT& prefix_op,
-    Int2Type<false> /* is_incclusive */)
+    Int2Type<false> /* is_inclusive */)
   {
     BlockScanT(storage.scan_storage.scan).ExclusiveScan(scan_items, scan_items, pair_scan_op, prefix_op);
     tile_aggregate = prefix_op.GetBlockAggregate();
@@ -281,7 +283,7 @@ struct AgentScanByKey
   _CCCL_DEVICE _CCCL_FORCEINLINE void
   UnzipValues(AccumT (&values)[ITEMS_PER_THREAD], SizeValuePairT (&scan_items)[ITEMS_PER_THREAD])
   {
-// Zip values and segment_flags
+// Unzip values and segment_flags
 #pragma unroll
     for (int ITEM = 0; ITEM < ITEMS_PER_THREAD; ++ITEM)
     {

diff --git a/cub/cub/block/block_discontinuity.cuh b/cub/cub/block/block_discontinuity.cuh
@@ -744,7 +744,7 @@ public:
   //!        // Collectively compute head and flags for discontinuities in the segment
   //!        int head_flags[4];
   //!        int tail_flags[4];
-  //!        BlockDiscontinuity(temp_storage).FlagTails(
+  //!        BlockDiscontinuity(temp_storage).FlagHeadsAndTails(
   //!            head_flags, tail_flags, thread_data, cub::Inequality());
   //!
   //! Suppose the set of input ``thread_data`` across the block of threads is
@@ -866,7 +866,7 @@ public:
   //!        // Collectively compute head and flags for discontinuities in the segment
   //!        int head_flags[4];
   //!        int tail_flags[4];
-  //!        BlockDiscontinuity(temp_storage).FlagTails(
+  //!        BlockDiscontinuity(temp_storage).FlagHeadsAndTails(
   //!            head_flags, tail_flags, tile_successor_item, thread_data, cub::Inequality());
   //!
   //! Suppose the set of input ``thread_data`` across the block of threads is
@@ -999,7 +999,7 @@ public:
   //!        // Collectively compute head and flags for discontinuities in the segment
   //!        int head_flags[4];
   //!        int tail_flags[4];
-  //!        BlockDiscontinuity(temp_storage).FlagTails(
+  //!        BlockDiscontinuity(temp_storage).FlagHeadsAndTails(
   //!            head_flags, tile_predecessor_item, tail_flags, tile_successor_item,
   //!            thread_data, cub::Inequality());
   //!
@@ -1128,7 +1128,7 @@ public:
   //!        // Collectively compute head and flags for discontinuities in the segment
   //!        int head_flags[4];
   //!        int tail_flags[4];
-  //!        BlockDiscontinuity(temp_storage).FlagTails(
+  //!        BlockDiscontinuity(temp_storage).FlagHeadsAndTails(
   //!            head_flags, tile_predecessor_item, tail_flags, tile_successor_item,
   //!            thread_data, cub::Inequality());
   //!

diff --git a/cub/cub/device/dispatch/dispatch_scan_by_key.cuh b/cub/cub/device/dispatch/dispatch_scan_by_key.cuh
@@ -65,7 +65,7 @@ CUB_NAMESPACE_BEGIN
  *****************************************************************************/
 
 /**
- * @brief Scan kernel entry point (multi-block)
+ * @brief Scan by key kernel entry point (multi-block)
  *
  * @tparam ChainedPolicyT
  *   Chained tuning policy