Merge pull request #1 from HapeMask/HapeMask-patch-1

Clarify docstring for num_items parameter of DeviceSegmentedRadixSort
NVIDIA · Aug 10, 2023 · 99ceb76 · 99ceb76
2 parents 9f01569 + cab5ef2
commit 99ceb76
Showing 1 changed file with 32 additions and 8 deletions.
diff --git a/cub/cub/device/device_segmented_radix_sort.cuh b/cub/cub/device/device_segmented_radix_sort.cuh
@@ -182,7 +182,10 @@ struct DeviceSegmentedRadixSort
    *   sequence of associated value items
    *
    * @param[in] num_items 
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments 
    *   The number of segments that comprise the sorting data
@@ -408,7 +411,10 @@ struct DeviceSegmentedRadixSort
    *   to the sorted output values
    *
    * @param[in] num_items 
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments 
    *   The number of segments that comprise the sorting data
@@ -615,7 +621,10 @@ struct DeviceSegmentedRadixSort
    *   sequence of associated value items
    *
    * @param[in] num_items 
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments 
    *   The number of segments that comprise the sorting data
@@ -843,7 +852,10 @@ struct DeviceSegmentedRadixSort
    *   to the sorted output values
    *
    * @param[in] num_items 
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments 
    *   The number of segments that comprise the sorting data
@@ -1040,7 +1052,10 @@ struct DeviceSegmentedRadixSort
    *   Device-accessible pointer to the sorted output sequence of key data
    *
    * @param[in] num_items  
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments  
    *   The number of segments that comprise the sorting data
@@ -1240,7 +1255,10 @@ struct DeviceSegmentedRadixSort
    *   point to the sorted output keys
    *
    * @param[in] num_items  
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments  
    *   The number of segments that comprise the sorting data
@@ -1431,7 +1449,10 @@ struct DeviceSegmentedRadixSort
    *   Device-accessible pointer to the sorted output sequence of key data
    *
    * @param[in] num_items  
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments  
    *   The number of segments that comprise the sorting data
@@ -1630,7 +1651,10 @@ struct DeviceSegmentedRadixSort
    *   point to the sorted output keys
    *
    * @param[in] num_items  
-   *   The total number of items to sort (across all segments)
+   *   The total number of items to sort (across all segments). If segments
+   *   are non-contiguous, this should include unused items in between
+   *   segments, namely all items between the start of the first and end
+   *   of the last segment.
    *
    * @param[in] num_segments  
    *   The number of segments that comprise the sorting data