deprecates policy hubs (#3514)

Author: elstehle

cub/cub/device/device_radix_sort.cuh

@@ -151,18 +151,22 @@ private:
     int end_bit,
     cudaStream_t stream)
   {
-    return DispatchRadixSort<IsDescending, KeyT, ValueT, OffsetT, DeviceRadixSortPolicy<KeyT, ValueT, OffsetT>, DecomposerT>::
-      Dispatch(
-        d_temp_storage,
-        temp_storage_bytes,
-        d_keys,
-        d_values,
-        static_cast<OffsetT>(num_items),
-        begin_bit,
-        end_bit,
-        is_overwrite_okay,
-        stream,
-        decomposer);
+    return DispatchRadixSort<
+      IsDescending,
+      KeyT,
+      ValueT,
+      OffsetT,
+      detail::radix::policy_hub<KeyT, ValueT, OffsetT>,
+      DecomposerT>::Dispatch(d_temp_storage,
+                             temp_storage_bytes,
+                             d_keys,
+                             d_values,
+                             static_cast<OffsetT>(num_items),
+                             begin_bit,
+                             end_bit,
+                             is_overwrite_okay,
+                             stream,
+                             decomposer);
   }
 
   template <bool IsDescending, typename KeyT, typename ValueT, typename NumItemsT, typename DecomposerT>

cub/cub/device/dispatch/dispatch_reduce.cuh

@@ -567,7 +567,7 @@ struct DispatchReduce
   template <typename ActivePolicyT>
   CUB_RUNTIME_FUNCTION _CCCL_FORCEINLINE cudaError_t Invoke(ActivePolicyT active_policy = {})
   {
-    auto wrapped_policy = MakeReducePolicyWrapper(active_policy);
+    auto wrapped_policy = detail::reduce::MakeReducePolicyWrapper(active_policy);
     if (num_items <= static_cast<OffsetT>(
           wrapped_policy.SingleTile().BlockThreads() * wrapped_policy.SingleTile().ItemsPerThread()))
     {

cub/cub/device/dispatch/dispatch_streaming_reduce.cuh

@@ -187,7 +187,7 @@ template <typename InputIteratorT,
           typename ReductionOpT,
           typename InitT,
           typename PolicyChainT =
-            DeviceReducePolicy<KeyValuePair<PerPartitionOffsetT, InitT>, PerPartitionOffsetT, ReductionOpT>>
+            detail::reduce::policy_hub<KeyValuePair<PerPartitionOffsetT, InitT>, PerPartitionOffsetT, ReductionOpT>>
 struct dispatch_streaming_arg_reduce_t
 {
   // Internal dispatch routine for computing a device-wide argument extremum, like `ArgMin` and `ArgMax`

cub/cub/device/dispatch/tuning/tuning_adjacent_difference.cuh

@@ -77,8 +77,9 @@ struct policy_hub
 } // namespace adjacent_difference
 } // namespace detail
 
-// TODO(bgruber): deprecate this alias. Users should not access policy_hubs directly.
 template <typename InputIteratorT, bool MayAlias = true>
-using DeviceAdjacentDifferencePolicy = detail::adjacent_difference::policy_hub<InputIteratorT, MayAlias>;
+using DeviceAdjacentDifferencePolicy CCCL_DEPRECATED_BECAUSE(
+  "This class is considered an implementation detail and it "
+  "will be removed.") = detail::adjacent_difference::policy_hub<InputIteratorT, MayAlias>;
 
 CUB_NAMESPACE_END

cub/cub/device/dispatch/tuning/tuning_merge_sort.cuh

@@ -92,6 +92,7 @@ struct policy_hub
 } // namespace detail
 
 template <typename KeyIteratorT>
-using DeviceMergeSortPolicy = detail::merge_sort::policy_hub<KeyIteratorT>;
+using DeviceMergeSortPolicy CCCL_DEPRECATED_BECAUSE("This class is considered an implementation detail and it will be "
+                                                    "removed.") = detail::merge_sort::policy_hub<KeyIteratorT>;
 
 CUB_NAMESPACE_END

cub/cub/device/dispatch/tuning/tuning_radix_sort.cuh

@@ -887,7 +887,6 @@ struct policy_hub
 } // namespace radix
 } // namespace detail
 
-// TODO(bgruber): deprecate this alias. Users should not access policy_hubs directly.
 /**
  * @brief Tuning policy for kernel specialization
  *
@@ -901,6 +900,7 @@ struct policy_hub
  *   Signed integer type for global offsets
  */
 template <typename KeyT, typename ValueT, typename OffsetT>
-using DeviceRadixSortPolicy = detail::radix::policy_hub<KeyT, ValueT, OffsetT>;
+using DeviceRadixSortPolicy CCCL_DEPRECATED_BECAUSE("This class is considered an implementation detail and it will be "
+                                                    "removed.") = detail::radix::policy_hub<KeyT, ValueT, OffsetT>;
 
 CUB_NAMESPACE_END

cub/cub/device/dispatch/tuning/tuning_reduce.cuh

@@ -141,7 +141,6 @@ struct policy_hub
 } // namespace reduce
 } // namespace detail
 
-// TODO(bgruber): deprecate at some point when we have a better API for users to supply tunings
 /// @tparam AccumT
 ///   Accumulator data type
 ///
@@ -152,10 +151,20 @@ struct policy_hub
 ///   Binary reduction functor type having member
 ///   `auto operator()(const T &a, const U &b)`
 template <typename AccumT, typename OffsetT, typename ReductionOpT>
-using DeviceReducePolicy = detail::reduce::policy_hub<AccumT, OffsetT, ReductionOpT>;
+using DeviceReducePolicy CCCL_DEPRECATED_BECAUSE(
+  "This class is considered an implementation detail and it will be "
+  "removed.") = detail::reduce::policy_hub<AccumT, OffsetT, ReductionOpT>;
 
-// TODO(bgruber): deprecate those
-using detail::reduce::MakeReducePolicyWrapper;
-using detail::reduce::ReducePolicyWrapper;
+template <typename PolicyT, typename Enable = void>
+using ReducePolicyWrapper CCCL_DEPRECATED_BECAUSE("This class is considered an implementation detail and it will be "
+                                                  "removed.") = detail::reduce::ReducePolicyWrapper<PolicyT, Enable>;
+
+template <typename PolicyT>
+CCCL_DEPRECATED_BECAUSE("This function is considered an implementation detail and it will "
+                        "be removed.")
+CUB_RUNTIME_FUNCTION detail::reduce::ReducePolicyWrapper<PolicyT> MakeReducePolicyWrapper(PolicyT policy)
+{
+  return detail::reduce::ReducePolicyWrapper<PolicyT>{policy};
+}
 
 CUB_NAMESPACE_END

cub/cub/device/dispatch/tuning/tuning_scan.cuh

@@ -332,8 +332,8 @@ struct policy_hub
 } // namespace scan
 } // namespace detail
 
-// TODO(bgruber): deprecate this at some point when we have a better way to allow users to supply tunings
 template <typename AccumT, typename ScanOpT = ::cuda::std::plus<>>
-using DeviceScanPolicy = detail::scan::policy_hub<AccumT, ScanOpT>;
+using DeviceScanPolicy CCCL_DEPRECATED_BECAUSE("This class is considered an implementation detail and it will be "
+                                               "removed.") = detail::scan::policy_hub<AccumT, ScanOpT>;
 
 CUB_NAMESPACE_END

cub/cub/device/dispatch/tuning/tuning_scan_by_key.cuh

@@ -790,8 +790,9 @@ struct policy_hub
 } // namespace scan_by_key
 } // namespace detail
 
-// TODO(bgruber): deprecate this at some point in the future when we have a better API for users to supply policies
 template <typename KeysInputIteratorT, typename AccumT, typename ValueT = AccumT, typename ScanOpT = ::cuda::std::plus<>>
-using DeviceScanByKeyPolicy = detail::scan_by_key::policy_hub<KeysInputIteratorT, AccumT, ValueT, ScanOpT>;
+using DeviceScanByKeyPolicy CCCL_DEPRECATED_BECAUSE(
+  "This class is considered an implementation detail and it will be "
+  "removed.") = detail::scan_by_key::policy_hub<KeysInputIteratorT, AccumT, ValueT, ScanOpT>;
 
 CUB_NAMESPACE_END

cub/cub/device/dispatch/tuning/tuning_segmented_sort.cuh

@@ -272,8 +272,9 @@ struct policy_hub
 } // namespace segmented_sort
 } // namespace detail
 
-// TODO(bgruber): Deprecate this at some point when we have a better API for users to provide tunings
 template <typename KeyT, typename ValueT>
-using DeviceSegmentedSortPolicy = detail::segmented_sort::policy_hub<KeyT, ValueT>;
+using DeviceSegmentedSortPolicy CCCL_DEPRECATED_BECAUSE(
+  "This class is considered an implementation detail and it will "
+  "be removed.") = detail::segmented_sort::policy_hub<KeyT, ValueT>;
 
 CUB_NAMESPACE_END