Improve comment about explicit specification of template args

Signed-off-by: Dan Hoeflinger <[email protected]>
uxlfoundation · Aug 28, 2024 · 127f2cb · 127f2cb
1 parent c3f87d3
commit 127f2cb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/include/oneapi/dpl/pstl/histogram_extension_defs.h b/include/oneapi/dpl/pstl/histogram_extension_defs.h
@@ -54,7 +54,8 @@ histogram(_ExecutionPolicy&& exec, _RandomAccessIterator1 first, _RandomAccessIt
 // This overload is provided to support an extension to the oneDPL specification to support the original implementation
 // of the histogram API, where if users explicitly-specify all template arguments, their arguments for bin boundary min
 // and max are convertible to the specified _ValueType, and the _ValueType is convertible to the value type of the
-// input iterator.
+// input iterator. Note that _ValueType is not deducable from the function arugments, so this overload is only used
+// when users explicitly specify the _ValueType template argument.
 template <typename _ExecutionPolicy, typename _RandomAccessIterator1, typename _Size, typename _RandomAccessIterator2,
           typename _ValueType, typename _RealValueType1, typename _RealValueType2>
 std::enable_if_t<

diff --git a/include/oneapi/dpl/pstl/histogram_impl.h b/include/oneapi/dpl/pstl/histogram_impl.h
@@ -106,7 +106,8 @@ histogram(_ExecutionPolicy&& exec, _RandomAccessIterator1 first, _RandomAccessIt
 // This overload is provided to support an extension to the oneDPL specification to support the original implementation
 // of the histogram API, where if users explicitly-specify all template arguments, their arguments for bin boundary min
 // and max are convertible to the specified _ValueType, and the _ValueType is convertible to the value type of the
-// input iterator.
+// input iterator. Note that _ValueType is not deducable from the function arugments, so this overload is only used
+// when users explicitly specify the _ValueType template argument.
 template <typename _ExecutionPolicy, typename _RandomAccessIterator1, typename _Size, typename _RandomAccessIterator2,
           typename _ValueType, typename _RealValueType1, typename _RealValueType2>
 std::enable_if_t<