Merge branch 'fix_documentation' into 'develop_stream'

unify language around config params in documentation See merge request amd/libraries/rocPRIM!559
ROCm · Oct 18, 2023 · 3a35351 · 3a35351
2 parents 15e1a67 + 04e4afb
commit 3a35351
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 57 deletions.
diff --git a/rocprim/include/rocprim/device/device_adjacent_difference.hpp b/rocprim/include/rocprim/device/device_adjacent_difference.hpp
@@ -245,7 +245,7 @@ hipError_t adjacent_difference_impl(void* const          temporary_storage,
 /// \endcode
 ///
 /// \tparam Config - [optional] configuration of the primitive. It has to be
-/// `adjacent_difference_config`.
+/// `adjacent_difference_config` or a class derived from it.
 /// \tparam InputIt - [inferred] random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam OutputIt - [inferred] random-access iterator type of the output range. Must meet the
@@ -341,7 +341,7 @@ hipError_t adjacent_difference(void* const          temporary_storage,
 /// \endcode
 ///
 /// \tparam Config - [optional] configuration of the primitive. It has to be
-/// `adjacent_difference_config`.
+/// `adjacent_difference_config` or a class derived from it.
 /// \tparam InputIt - [inferred] random-access iterator type of the value range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam BinaryFunction - [inferred] binary operation function object that will be applied to
@@ -394,7 +394,7 @@ hipError_t adjacent_difference_inplace(void* const          temporary_storage,
 /// \endcode
 ///
 /// \tparam Config - [optional] configuration of the primitive. It has to be
-/// `adjacent_difference_config`.
+/// `adjacent_difference_config` or a class derived from it.
 /// \tparam InputIt - [inferred] random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam OutputIt - [inferred] random-access iterator type of the output range. Must meet the
@@ -490,7 +490,7 @@ hipError_t adjacent_difference_right(void* const          temporary_storage,
 /// \endcode
 ///
 /// \tparam Config - [optional] configuration of the primitive. It has to be
-/// `adjacent_difference_config`.
+/// `adjacent_difference_config` or a class derived from it.
 /// \tparam InputIt - [inferred] random-access iterator type of the value range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam BinaryFunction - [inferred] binary operation function object that will be applied to

diff --git a/rocprim/include/rocprim/device/device_binary_search.hpp b/rocprim/include/rocprim/device/device_binary_search.hpp
@@ -114,8 +114,8 @@ struct is_default_or_has_tag<default_config, Tag>
 /// in the semi-open interval <tt>[lower_output[i], upper_output[i])</tt> of \p haystack, in case of
 /// being present at all.
 ///
-/// @tparam Config - [optional] Configuration of the primitive. It can be \p lower_bound_config or
-/// a class with the same members. Default is \p default_config.
+/// @tparam Config - [optional] Configuration of the primitive. It has to be \p lower_bound_config or
+/// a class derived from it. Default is \p default_config.
 /// @tparam HaystackIterator - [inferred] Random-access iterator type of the search range. Must meet
 /// the requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// @tparam NeedlesIterator - [inferred] Random-access iterator type of the input range. Must meet
@@ -251,7 +251,7 @@ hipError_t lower_bound(void * temporary_storage,
 /// being present at all.
 ///
 /// @tparam Config - [optional] Configuration of the primitive. It can be \p upper_bound_config or
-/// a class with the same members. Default is \p default_config.
+/// a class derived from it. Default is \p default_config.
 /// @tparam HaystackIterator - [inferred] Random-access iterator type of the search range. Must meet
 /// the requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// @tparam NeedlesIterator - [inferred] Random-access iterator type of the input range. Must meet
@@ -381,7 +381,7 @@ hipError_t upper_bound(void * temporary_storage,
 /// is written to \p storage_size and the function returns without performing the search operation.
 ///
 /// @tparam Config - [optional] Configuration of the primitive. It can be \p binary_search_config or
-/// a class with the same members. Default is \p default_config.
+/// a class derived from it. Default is \p default_config.
 /// @tparam HaystackIterator - [inferred] Random-access iterator type of the search range. Must meet
 /// the requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// @tparam NeedlesIterator - [inferred] Random-access iterator type of the input range. Must meet

diff --git a/rocprim/include/rocprim/device/device_histogram.hpp b/rocprim/include/rocprim/device/device_histogram.hpp
@@ -449,7 +449,7 @@ inline hipError_t histogram_range_impl(void*          temporary_storage,
 /// * Returns the required size of \p temporary_storage in \p storage_size
 /// if \p temporary_storage in a null pointer.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -552,7 +552,7 @@ inline hipError_t histogram_even(void*          temporary_storage,
 /// * Returns the required size of \p temporary_storage in \p storage_size
 /// if \p temporary_storage in a null pointer.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -663,7 +663,7 @@ inline hipError_t histogram_even(void*          temporary_storage,
 ///
 /// \tparam Channels - number of channels interleaved in the input samples.
 /// \tparam ActiveChannels - number of channels being used for computing histograms.
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -775,7 +775,7 @@ inline hipError_t multi_histogram_even(void*          temporary_storage,
 ///
 /// \tparam Channels - number of channels interleaved in the input samples.
 /// \tparam ActiveChannels - number of channels being used for computing histograms.
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -882,7 +882,7 @@ inline hipError_t multi_histogram_even(void*          temporary_storage,
 /// * Returns the required size of \p temporary_storage in \p storage_size
 /// if \p temporary_storage in a null pointer.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -979,7 +979,7 @@ inline hipError_t histogram_range(void*          temporary_storage,
 /// * Returns the required size of \p temporary_storage in \p storage_size
 /// if \p temporary_storage in a null pointer.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -1085,7 +1085,7 @@ inline hipError_t histogram_range(void*          temporary_storage,
 ///
 /// \tparam Channels - number of channels interleaved in the input samples.
 /// \tparam ActiveChannels - number of channels being used for computing histograms.
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.
@@ -1192,7 +1192,7 @@ inline hipError_t multi_histogram_range(void*          temporary_storage,
 ///
 /// \tparam Channels - number of channels interleaved in the input samples.
 /// \tparam ActiveChannels - number of channels being used for computing histograms.
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p histogram_config or a class derived from it.
 /// \tparam SampleIterator - random-access iterator type of the input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam Counter - integer type for histogram bin counters.

diff --git a/rocprim/include/rocprim/device/device_merge.hpp b/rocprim/include/rocprim/device/device_merge.hpp
@@ -216,7 +216,7 @@ hipError_t merge_impl(void * temporary_storage,
 /// if \p temporary_storage in a null pointer.
 /// * Accepts custom compare_functions for merging across the device.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p merge_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p merge_config or a class derived from it.
 /// \tparam InputIterator1 - random-access iterator type of the first input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam InputIterator2 - random-access iterator type of the second input range. Must meet the
@@ -320,7 +320,7 @@ hipError_t merge(void * temporary_storage,
 /// if \p temporary_storage in a null pointer.
 /// * Accepts custom compare_functions for merging across the device.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p merge_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p merge_config or a class derived from it.
 /// \tparam KeysInputIterator1 - random-access iterator type of the first keys input range. Must meet the
 /// requirements of a C++ InputIterator concept. It can be a simple pointer type.
 /// \tparam KeysInputIterator2 - random-access iterator type of the second keys input range. Must meet the

diff --git a/rocprim/include/rocprim/device/device_partition.hpp b/rocprim/include/rocprim/device/device_partition.hpp
@@ -382,7 +382,7 @@ hipError_t partition_impl(void * temporary_storage,
 /// * Range specified by \p selected_count_output must have at least 1 element.
 /// * Relative order is preserved.
 ///
-/// \tparam Config - [optional] configuration of the primitive. If has to be an instance of \p select_config.
+/// \tparam Config - [optional] configuration of the primitive. If has to be an instance of \p select_config or a class derived from it.
 /// \tparam InputIterator - random-access iterator type of the input range. It can be a simple
 /// pointer type.
 /// \tparam SelectedOutputIterator - random-access iterator type of the selected output range. It
@@ -528,7 +528,7 @@ inline hipError_t partition_two_way(void*                       temporary_storag
 /// * Values of \p flag range should be implicitly convertible to `bool` type.
 /// * The relative order of elements in both output ranges matches the input range.
 ///
-/// \tparam Config - [optional] configuration of the primitive. If has to be an instance of \p select_config.
+/// \tparam Config - [optional] configuration of the primitive. If has to be an instance of \p select_config or a class derived from it.
 /// \tparam InputIterator - random-access iterator type of the input range. It can be
 /// a simple pointer type.
 /// \tparam FlagIterator - random-access iterator type of the flag range. It can be
@@ -662,7 +662,7 @@ inline hipError_t partition_two_way(void*                       temporary_storag
 /// * Relative order is preserved for the elements for which the corresponding values from \p flags
 /// are \p true. Other elements are copied in reverse order.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p select_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p select_config or a class derived from it.
 /// \tparam InputIterator - random-access iterator type of the input range. It can be
 /// a simple pointer type.
 /// \tparam FlagIterator - random-access iterator type of the flag range. It can be
@@ -783,7 +783,7 @@ hipError_t partition(void * temporary_storage,
 /// * Relative order is preserved for the elements for which the \p predicate returns \p true. Other
 /// elements are copied in reverse order.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p select_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p select_config or a class derived from it.
 /// \tparam InputIterator - random-access iterator type of the input range. It can be
 /// a simple pointer type.
 /// \tparam OutputIterator - random-access iterator type of the output range. It can be
@@ -927,7 +927,7 @@ hipError_t partition(void * temporary_storage,
 /// minus the number of elements written to \p output_first_part minus the number of elements written
 /// to \p output_second_part.
 ///
-/// \tparam Config - [optional] configuration of the primitive. It has to be \p select_config.
+/// \tparam Config - [optional] configuration of the primitive. It has to be \p select_config or a class derived from it.
 /// \tparam InputIterator - random-access iterator type of the input range. It can be
 /// a simple pointer type.
 /// \tparam FirstOutputIterator - random-access iterator type of the first output range. It can be