From cf0b2caffd4ead3dc73025d95ae2dee11c539e9e Mon Sep 17 00:00:00 2001 From: Karthikeyan <6488848+karthikeyann@users.noreply.github.com> Date: Fri, 1 Oct 2021 22:57:55 +0530 Subject: [PATCH] doc reorder mr, stream to stream, mr (#9308) Doc reorder mr, stream to stream, mr Authors: - Karthikeyan (https://github.com/karthikeyann) Approvers: - David Wendt (https://github.com/davidwendt) - MithunR (https://github.com/mythrocks) URL: https://github.com/rapidsai/cudf/pull/9308 --- cpp/include/cudf/detail/copy_if_else.cuh | 2 +- cpp/include/cudf/detail/gather.cuh | 2 +- cpp/include/cudf/detail/gather.hpp | 2 +- .../cudf/detail/reduction_functions.hpp | 22 +++++++-------- .../cudf/dictionary/detail/concatenate.hpp | 2 +- .../cudf/dictionary/detail/update_keys.hpp | 2 +- .../cudf/strings/detail/concatenate.hpp | 2 +- .../cudf/strings/detail/copy_if_else.cuh | 2 +- .../cudf/strings/detail/copy_range.cuh | 2 +- cpp/include/cudf/strings/detail/fill.hpp | 2 +- cpp/include/cudf/strings/detail/gather.cuh | 6 ++-- cpp/include/cudf/strings/detail/merge.cuh | 2 +- cpp/include/cudf/strings/detail/scatter.cuh | 2 +- cpp/include/cudf/strings/detail/utilities.cuh | 8 +++--- cpp/include/nvtext/detail/tokenize.hpp | 8 +++--- cpp/src/binaryop/binaryop.cpp | 12 ++++---- cpp/src/binaryop/compiled/binary_ops.hpp | 9 ++++-- cpp/src/dictionary/remove_keys.cu | 2 +- cpp/src/dictionary/replace.cu | 2 +- cpp/src/groupby/hash/groupby.cu | 2 +- cpp/src/groupby/sort/group_reductions.hpp | 28 +++++++++---------- cpp/src/io/csv/writer_impl.cu | 6 ++-- cpp/src/io/parquet/writer_impl.hpp | 2 +- cpp/src/partitioning/round_robin.cu | 2 +- cpp/src/reductions/minmax.cu | 20 +++++++------ cpp/src/reductions/simple.cuh | 12 ++++---- cpp/src/strings/find.cu | 6 ++-- cpp/src/strings/substring.cu | 2 +- cpp/src/unary/cast_ops.cu | 2 +- 29 files changed, 90 insertions(+), 83 deletions(-) diff --git a/cpp/include/cudf/detail/copy_if_else.cuh b/cpp/include/cudf/detail/copy_if_else.cuh index 74a94f34ad8..d794adceec2 100644 --- a/cpp/include/cudf/detail/copy_if_else.cuh +++ b/cpp/include/cudf/detail/copy_if_else.cuh @@ -152,8 +152,8 @@ __launch_bounds__(block_size) __global__ * @param filter Function of type `FilterFn` which determines for index `i` where to get the * corresponding output value from * @param out_type `cudf::data_type` of the returned column - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory * @return A new column that contains the values from either `lhs` or `rhs` as determined * by `filter[i]` */ diff --git a/cpp/include/cudf/detail/gather.cuh b/cpp/include/cudf/detail/gather.cuh index 06de9ff2716..5d649e55389 100644 --- a/cpp/include/cudf/detail/gather.cuh +++ b/cpp/include/cudf/detail/gather.cuh @@ -640,8 +640,8 @@ void gather_bitmask(table_view const& source, * use `DONT_CHECK` when they are certain that the gather_map contains only valid indices for * better performance. In case there are out-of-bound indices in the gather map, the behavior * is undefined. Defaults to `DONT_CHECK`. - * @param[in] mr Device memory resource used to allocate the returned table's device memory * @param[in] stream CUDA stream used for device memory operations and kernel launches. + * @param[in] mr Device memory resource used to allocate the returned table's device memory * @return cudf::table Result of the gather */ template diff --git a/cpp/include/cudf/detail/gather.hpp b/cpp/include/cudf/detail/gather.hpp index 268c4878444..b01690f82df 100644 --- a/cpp/include/cudf/detail/gather.hpp +++ b/cpp/include/cudf/detail/gather.hpp @@ -56,8 +56,8 @@ enum class negative_index_policy : bool { ALLOWED, NOT_ALLOWED }; * the behavior is undefined. * @param[in] negative_index_policy Interpret each negative index `i` in the * gathermap as the positive index `i+num_source_rows`. - * @param[in] mr Device memory resource used to allocate the returned table's device memory * @param[in] stream CUDA stream used for device memory operations and kernel launches. + * @param[in] mr Device memory resource used to allocate the returned table's device memory * @return cudf::table Result of the gather */ std::unique_ptr gather( diff --git a/cpp/include/cudf/detail/reduction_functions.hpp b/cpp/include/cudf/detail/reduction_functions.hpp index 01df55dea05..0565f332b48 100644 --- a/cpp/include/cudf/detail/reduction_functions.hpp +++ b/cpp/include/cudf/detail/reduction_functions.hpp @@ -33,8 +33,8 @@ namespace reduction { * * @param col input column to compute sum * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Sum as scalar of type `output_dtype`. */ std::unique_ptr sum( @@ -52,8 +52,8 @@ std::unique_ptr sum( * * @param col input column to compute minimum. * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Minimum element as scalar of type `output_dtype`. */ std::unique_ptr min( @@ -71,8 +71,8 @@ std::unique_ptr min( * * @param col input column to compute maximum. * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Maximum element as scalar of type `output_dtype`. */ std::unique_ptr max( @@ -91,8 +91,8 @@ std::unique_ptr max( * * @param col input column to compute any_of. * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return bool scalar if any of elements is true when typecasted to bool */ std::unique_ptr any( @@ -111,8 +111,8 @@ std::unique_ptr any( * * @param col input column to compute all_of. * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return bool scalar if all of elements is true when typecasted to bool */ std::unique_ptr all( @@ -131,8 +131,8 @@ std::unique_ptr all( * * @param col input column to compute product. * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Product as scalar of type `output_dtype`. */ std::unique_ptr product( @@ -151,8 +151,8 @@ std::unique_ptr product( * * @param col input column to compute sum of squares. * @param output_dtype data type of return type and typecast elements of input column - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Sum of squares as scalar of type `output_dtype`. */ std::unique_ptr sum_of_squares( @@ -171,8 +171,8 @@ std::unique_ptr sum_of_squares( * * @param col input column to compute mean. * @param output_dtype data type of return type and typecast elements of input column. - * @param mr Device memory resource used to allocate the returned scalar's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory. * @return Mean as scalar of type `output_dtype`. */ std::unique_ptr mean( @@ -191,8 +191,8 @@ std::unique_ptr mean( * * @param col input column to compute variance. * @param output_dtype data type of return type and typecast elements of input column. - * @param mr Device memory resource used to allocate the returned scalar's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory. * @return Variance as scalar of type `output_dtype`. */ std::unique_ptr variance( @@ -212,8 +212,8 @@ std::unique_ptr variance( * * @param col input column to compute standard deviation. * @param output_dtype data type of return type and typecast elements of input column. - * @param mr Device memory resource used to allocate the returned scalar's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory. * @return Standard deviation as scalar of type `output_dtype`. */ std::unique_ptr standard_deviation( @@ -243,8 +243,8 @@ std::unique_ptr standard_deviation( * @param col input column to get nth element from. * @param n index of element to get * @param null_handling Indicates if null values will be counted while indexing. - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return nth element as scalar */ std::unique_ptr nth_element( diff --git a/cpp/include/cudf/dictionary/detail/concatenate.hpp b/cpp/include/cudf/dictionary/detail/concatenate.hpp index c2fe2dce1fe..00d2c820b61 100644 --- a/cpp/include/cudf/dictionary/detail/concatenate.hpp +++ b/cpp/include/cudf/dictionary/detail/concatenate.hpp @@ -32,8 +32,8 @@ namespace detail { * @throw cudf::logic_error if dictionary column keys are not all the same type. * * @param columns Vector of dictionary columns to concatenate. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with concatenated results. */ std::unique_ptr concatenate( diff --git a/cpp/include/cudf/dictionary/detail/update_keys.hpp b/cpp/include/cudf/dictionary/detail/update_keys.hpp index 8c037406e45..e1d5f0367e0 100644 --- a/cpp/include/cudf/dictionary/detail/update_keys.hpp +++ b/cpp/include/cudf/dictionary/detail/update_keys.hpp @@ -98,8 +98,8 @@ std::vector> match_dictionaries( * Any null rows are left unchanged. * * @param input Vector of cudf::table_views that include dictionary columns to be matched. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New dictionary columns and updated cudf::table_views. */ std::pair>, std::vector> match_dictionaries( diff --git a/cpp/include/cudf/strings/detail/concatenate.hpp b/cpp/include/cudf/strings/detail/concatenate.hpp index 0740039e896..3512c05a586 100644 --- a/cpp/include/cudf/strings/detail/concatenate.hpp +++ b/cpp/include/cudf/strings/detail/concatenate.hpp @@ -37,8 +37,8 @@ namespace detail { * ``` * * @param columns List of string columns to concatenate. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with concatenated results. */ std::unique_ptr concatenate( diff --git a/cpp/include/cudf/strings/detail/copy_if_else.cuh b/cpp/include/cudf/strings/detail/copy_if_else.cuh index 72f9ac11ceb..b6d34f8d89a 100644 --- a/cpp/include/cudf/strings/detail/copy_if_else.cuh +++ b/cpp/include/cudf/strings/detail/copy_if_else.cuh @@ -47,8 +47,8 @@ namespace detail { * @param rhs_begin Strings of second set of data. Used when filter_fn returns false. * @param filter_fn Called to determine which iterator (lhs or rhs) to retrieve an entry for a * specific row. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ template diff --git a/cpp/include/cudf/strings/detail/copy_range.cuh b/cpp/include/cudf/strings/detail/copy_range.cuh index 7e8ab6a0b68..05dbdf18b64 100644 --- a/cpp/include/cudf/strings/detail/copy_range.cuh +++ b/cpp/include/cudf/strings/detail/copy_range.cuh @@ -93,8 +93,8 @@ namespace detail { * @param target_begin The starting index of the target range (inclusive) * @param target_end The index of the last element in the target range * (exclusive) - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return std::unique_ptr The result target column */ template diff --git a/cpp/include/cudf/strings/detail/fill.hpp b/cpp/include/cudf/strings/detail/fill.hpp index 1ddf0ad5cdf..040175af9e5 100644 --- a/cpp/include/cudf/strings/detail/fill.hpp +++ b/cpp/include/cudf/strings/detail/fill.hpp @@ -37,8 +37,8 @@ namespace detail { * @param begin First row index to include the new string. * @param end Last row index (exclusive). * @param value String to use when filling the range. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr fill( diff --git a/cpp/include/cudf/strings/detail/gather.cuh b/cpp/include/cudf/strings/detail/gather.cuh index faae9a50be2..16955b3251b 100644 --- a/cpp/include/cudf/strings/detail/gather.cuh +++ b/cpp/include/cudf/strings/detail/gather.cuh @@ -213,8 +213,8 @@ __global__ void gather_chars_fn_char_parallel(StringIterator strings_begin, * @param map_end End of index iterator. * @param offsets The offset values to be associated with the output chars column. * @param chars_bytes The total number of bytes for the output chars column. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New chars column fit for a strings column. */ template @@ -278,8 +278,8 @@ std::unique_ptr gather_chars(StringIterator strings_begin, * @param strings Strings instance for this operation. * @param begin Start of index iterator. * @param end End of index iterator. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column containing the gathered strings. */ template @@ -361,8 +361,8 @@ std::unique_ptr gather( * @param begin Start of index iterator. * @param end End of index iterator. * @param nullify_out_of_bounds If true, indices outside the column's range are nullified. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column containing the gathered strings. */ template diff --git a/cpp/include/cudf/strings/detail/merge.cuh b/cpp/include/cudf/strings/detail/merge.cuh index d632e6c24cb..4657f6c83bd 100644 --- a/cpp/include/cudf/strings/detail/merge.cuh +++ b/cpp/include/cudf/strings/detail/merge.cuh @@ -39,8 +39,8 @@ namespace detail { * @param lhs First column. * @param rhs Second column. * @param row_order Indexes for each column. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ template diff --git a/cpp/include/cudf/strings/detail/scatter.cuh b/cpp/include/cudf/strings/detail/scatter.cuh index eb7493f4895..0a53c930bb3 100644 --- a/cpp/include/cudf/strings/detail/scatter.cuh +++ b/cpp/include/cudf/strings/detail/scatter.cuh @@ -48,8 +48,8 @@ namespace detail { * @param scatter_map Iterator of indices into the output column. * @param target The set of columns into which values from the source column * are to be scattered. - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ template diff --git a/cpp/include/cudf/strings/detail/utilities.cuh b/cpp/include/cudf/strings/detail/utilities.cuh index 6894c34a077..efd03d882e6 100644 --- a/cpp/include/cudf/strings/detail/utilities.cuh +++ b/cpp/include/cudf/strings/detail/utilities.cuh @@ -41,8 +41,8 @@ namespace detail { * @tparam Iterator Used as input to scan to set the offset values. * @param begin The beginning of the input sequence * @param end The end of the input sequence - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return offsets child column for strings column */ template @@ -74,8 +74,8 @@ std::unique_ptr make_offsets_child_column( * @tparam Iter Iterator type that returns string_view instances * @param strings_begin Iterator to the beginning of the string_view sequence * @param num_strings The number of string_view instances in the sequence - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return Child offsets column */ template @@ -131,8 +131,8 @@ __device__ inline char* copy_string(char* buffer, const string_view& d_string) * chars memory. * @param exec_size Number of rows for executing the `size_and_exec_fn` function. * @param strings_count Number of strings. - * @param mr Device memory resource used to allocate the returned columns' device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned columns' device memory. * @return offsets child column and chars child column for a strings column */ template @@ -190,8 +190,8 @@ auto make_strings_children( * After that, the d_offsets and d_chars are set and this is called again to fill in the * chars memory. * @param strings_count Number of strings. - * @param mr Device memory resource used to allocate the returned columns' device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned columns' device memory. * @return offsets child column and chars child column for a strings column */ template diff --git a/cpp/include/nvtext/detail/tokenize.hpp b/cpp/include/nvtext/detail/tokenize.hpp index 8b74c9cde94..faddfef8be2 100644 --- a/cpp/include/nvtext/detail/tokenize.hpp +++ b/cpp/include/nvtext/detail/tokenize.hpp @@ -30,8 +30,8 @@ namespace detail { * @param strings Strings column tokenize. * @param delimiter UTF-8 characters used to separate each string into tokens. * The default of empty string will separate tokens using whitespace. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings columns of tokens. */ std::unique_ptr tokenize( @@ -46,8 +46,8 @@ std::unique_ptr tokenize( * * @param strings Strings column to tokenize. * @param delimiters Strings used to separate individual strings into tokens. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings columns of tokens. */ std::unique_ptr tokenize( @@ -63,8 +63,8 @@ std::unique_ptr tokenize( * @param strings Strings column to use for this operation. * @param delimiter Strings used to separate each string into tokens. * The default of empty string will separate tokens using whitespace. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT32 column of token counts. */ std::unique_ptr count_tokens( @@ -79,8 +79,8 @@ std::unique_ptr count_tokens( * * @param strings Strings column to use for this operation. * @param delimiters Strings used to separate each string into tokens. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT32 column of token counts. */ std::unique_ptr count_tokens( diff --git a/cpp/src/binaryop/binaryop.cpp b/cpp/src/binaryop/binaryop.cpp index a1b00a4cd6b..6b03a97c59b 100644 --- a/cpp/src/binaryop/binaryop.cpp +++ b/cpp/src/binaryop/binaryop.cpp @@ -324,8 +324,8 @@ namespace detail { * @param rhs Right-hand side `column_view` used in the binary operation * @param op `binary_operator` to be used to combine `lhs` and `rhs` * @param output_type `data_type` of the output column - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations + * @param mr Device memory resource to use for device memory allocation * @return std::unique_ptr Output column used for binary operation */ std::unique_ptr make_fixed_width_column_for_output(scalar const& lhs, @@ -351,8 +351,8 @@ std::unique_ptr make_fixed_width_column_for_output(scalar const& lhs, * @param rhs Right-hand side `scalar` used in the binary operation * @param op `binary_operator` to be used to combine `lhs` and `rhs` * @param output_type `data_type` of the output column - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations + * @param mr Device memory resource to use for device memory allocation * @return std::unique_ptr Output column used for binary operation */ std::unique_ptr make_fixed_width_column_for_output(column_view const& lhs, @@ -378,8 +378,8 @@ std::unique_ptr make_fixed_width_column_for_output(column_view const& lh * @param rhs Right-hand side `column_view` used in the binary operation * @param op `binary_operator` to be used to combine `lhs` and `rhs` * @param output_type `data_type` of the output column - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations + * @param mr Device memory resource to use for device memory allocation * @return std::unique_ptr Output column used for binary operation */ std::unique_ptr make_fixed_width_column_for_output(column_view const& lhs, @@ -426,8 +426,8 @@ namespace jit { * @param lhs Left-hand side `scalar` used in the binary operation * @param rhs Right-hand side `column_view` used in the binary operation * @param op `binary_operator` to be used to combine `lhs` and `rhs` - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations + * @param mr Device memory resource to use for device memory allocation * @return std::unique_ptr Resulting output column from the binary operation */ std::unique_ptr fixed_point_binary_operation(scalar const& lhs, @@ -496,8 +496,8 @@ std::unique_ptr fixed_point_binary_operation(scalar const& lhs, * @param lhs Left-hand side `column_view` used in the binary operation * @param rhs Right-hand side `scalar` used in the binary operation * @param op `binary_operator` to be used to combine `lhs` and `rhs` - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations + * @param mr Device memory resource to use for device memory allocation * @return std::unique_ptr Resulting output column from the binary operation */ std::unique_ptr fixed_point_binary_operation(column_view const& lhs, @@ -566,8 +566,8 @@ std::unique_ptr fixed_point_binary_operation(column_view const& lhs, * @param lhs Left-hand side `column_view` used in the binary operation * @param rhs Right-hand side `column_view` used in the binary operation * @param op `binary_operator` to be used to combine `lhs` and `rhs` - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations + * @param mr Device memory resource to use for device memory allocation * @return std::unique_ptr Resulting output column from the binary operation */ std::unique_ptr fixed_point_binary_operation(column_view const& lhs, diff --git a/cpp/src/binaryop/compiled/binary_ops.hpp b/cpp/src/binaryop/compiled/binary_ops.hpp index cf3a6025847..26a0f26b59c 100644 --- a/cpp/src/binaryop/compiled/binary_ops.hpp +++ b/cpp/src/binaryop/compiled/binary_ops.hpp @@ -68,9 +68,10 @@ std::unique_ptr string_null_min_max( * * @param lhs The left operand string scalar * @param rhs The right operand string column + * @param op The binary operator * @param output_type The desired data type of the output column - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory * @return std::unique_ptr Output column */ std::unique_ptr binary_operation( @@ -94,9 +95,10 @@ std::unique_ptr binary_operation( * * @param lhs The left operand string column * @param rhs The right operand string scalar + * @param op The binary operator * @param output_type The desired data type of the output column - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory * @return std::unique_ptr Output column */ std::unique_ptr binary_operation( @@ -119,9 +121,10 @@ std::unique_ptr binary_operation( * * @param lhs The left operand string column * @param rhs The right operand string column + * @param op The binary operator enum * @param output_type The desired data type of the output column - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory * @return std::unique_ptr Output column */ std::unique_ptr binary_operation( diff --git a/cpp/src/dictionary/remove_keys.cu b/cpp/src/dictionary/remove_keys.cu index 16b86177b8e..7e2a82a683c 100644 --- a/cpp/src/dictionary/remove_keys.cu +++ b/cpp/src/dictionary/remove_keys.cu @@ -49,8 +49,8 @@ namespace { * and returns true if that key is to be used in the output dictionary. * @param dictionary_column The column to use for creating the new dictionary. * @param keys_to_keep_fn Called to determine which keys in `dictionary_column` to keep. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. */ template std::unique_ptr remove_keys_fn( diff --git a/cpp/src/dictionary/replace.cu b/cpp/src/dictionary/replace.cu index 37118779248..11c81ee434b 100644 --- a/cpp/src/dictionary/replace.cu +++ b/cpp/src/dictionary/replace.cu @@ -44,8 +44,8 @@ namespace { * * @param input lhs for `copy_if_else` * @param replacement_iter rhs for `copy_if_else` - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return Always returns column of type INT32 (size_type) */ template diff --git a/cpp/src/groupby/hash/groupby.cu b/cpp/src/groupby/hash/groupby.cu index 694ca2afceb..aa7915e6c8b 100644 --- a/cpp/src/groupby/hash/groupby.cu +++ b/cpp/src/groupby/hash/groupby.cu @@ -170,8 +170,8 @@ class hash_compound_agg_finalizer final : public cudf::detail::aggregation_final size_type const map_size; Map const& map; bitmask_type const* __restrict__ row_bitmask; - rmm::mr::device_memory_resource* mr; rmm::cuda_stream_view stream; + rmm::mr::device_memory_resource* mr; public: using cudf::detail::aggregation_finalizer::visit; diff --git a/cpp/src/groupby/sort/group_reductions.hpp b/cpp/src/groupby/sort/group_reductions.hpp index cb01ee8e053..f5060a6ed4e 100644 --- a/cpp/src/groupby/sort/group_reductions.hpp +++ b/cpp/src/groupby/sort/group_reductions.hpp @@ -45,8 +45,8 @@ namespace detail { * @param values Grouped values to get sum of * @param num_groups Number of groups * @param group_labels ID of group that the corresponding value belongs to - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_sum(column_view const& values, size_type num_groups, @@ -68,8 +68,8 @@ std::unique_ptr group_sum(column_view const& values, * @param values Grouped values to get product of * @param num_groups Number of groups * @param group_labels ID of group that the corresponding value belongs to - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_product(column_view const& values, size_type num_groups, @@ -91,8 +91,8 @@ std::unique_ptr group_product(column_view const& values, * @param values Grouped values to get minimum from * @param num_groups Number of groups * @param group_labels ID of group that the corresponding value belongs to - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_min(column_view const& values, size_type num_groups, @@ -114,8 +114,8 @@ std::unique_ptr group_min(column_view const& values, * @param values Grouped values to get maximum from * @param num_groups Number of groups * @param group_labels ID of group that the corresponding value belongs to - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_max(column_view const& values, size_type num_groups, @@ -138,8 +138,8 @@ std::unique_ptr group_max(column_view const& values, * @param num_groups Number of groups * @param group_labels ID of group that the corresponding value belongs to * @param key_sort_order Indices indicating sort order of groupby keys - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_argmax(column_view const& values, size_type num_groups, @@ -163,8 +163,8 @@ std::unique_ptr group_argmax(column_view const& values, * @param num_groups Number of groups * @param group_labels ID of group that the corresponding value belongs to * @param key_sort_order Indices indicating sort order of groupby keys - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_argmin(column_view const& values, size_type num_groups, @@ -188,8 +188,8 @@ std::unique_ptr group_argmin(column_view const& values, * @param values Grouped values to get valid count of * @param group_labels ID of group that the corresponding value belongs to * @param num_groups Number of groups ( unique values in @p group_labels ) - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_count_valid(column_view const& values, cudf::device_span group_labels, @@ -209,8 +209,8 @@ std::unique_ptr group_count_valid(column_view const& values, * * @param group_offsets Offsets of groups' starting points within @p values * @param num_groups Number of groups ( unique values in @p group_labels ) - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_count_all(cudf::device_span group_offsets, size_type num_groups, @@ -232,8 +232,8 @@ std::unique_ptr group_count_all(cudf::device_span group * @param values Grouped values to compute M2 values * @param group_means Pre-computed groupwise MEAN * @param group_labels ID of group corresponding value in @p values belongs to - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_m2(column_view const& values, column_view const& group_means, @@ -260,8 +260,8 @@ std::unique_ptr group_m2(column_view const& values, * @param group_labels ID of group corresponding value in @p values belongs to * @param ddof Delta degrees of freedom. The divisor used in calculation of * `var` is `N - ddof`, where `N` is the group size. - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_var(column_view const& values, column_view const& group_means, @@ -289,8 +289,8 @@ std::unique_ptr group_var(column_view const& values, * @param group_offsets Offsets of groups' starting points within @p values * @param quantiles List of quantiles q where q lies in [0,1] * @param interp Method to use when desired value lies between data points - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_quantiles(column_view const& values, column_view const& group_sizes, @@ -322,8 +322,8 @@ std::unique_ptr group_quantiles(column_view const& values, * @param null_handling Exclude nulls while counting if null_policy::EXCLUDE, * Include nulls if null_policy::INCLUDE. * Nulls are treated equal. - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_nunique(column_view const& values, cudf::device_span group_labels, @@ -355,8 +355,8 @@ std::unique_ptr group_nunique(column_view const& values, * @param n nth element to choose from each group of @p values * @param null_handling Exclude nulls while counting if null_policy::EXCLUDE, * Include nulls if null_policy::INCLUDE. - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_nth_element(column_view const& values, column_view const& group_sizes, @@ -433,8 +433,8 @@ std::unique_ptr group_merge_lists(column_view const& values, * @param values Grouped values (tuples of values `(valid_count, mean, M2)`) to merge. * @param group_offsets Offsets of groups' starting points within @p values. * @param num_groups Number of groups. - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory */ std::unique_ptr group_merge_m2(column_view const& values, cudf::device_span group_offsets, diff --git a/cpp/src/io/csv/writer_impl.cu b/cpp/src/io/csv/writer_impl.cu index de75ea6a51d..9a0c701ea49 100644 --- a/cpp/src/io/csv/writer_impl.cu +++ b/cpp/src/io/csv/writer_impl.cu @@ -135,9 +135,9 @@ struct column_to_strings_fn { // instead of column-wise; might be faster // // Note: Cannot pass `stream` to detail:: version of calls below, because they are - // not exposed in header (see, for example, detail::concatenate(tbl_view, separator, na_rep, mr, - // stream) is declared and defined in combine.cu); Possible solution: declare `extern`, or just - // declare a prototype inside `namespace cudf::strings::detail`; + // not exposed in header (see, for example, detail::concatenate(tbl_view, separator, na_rep, + // stream, mr) is declared and defined in combine.cu); Possible solution: declare `extern`, or + // just declare a prototype inside `namespace cudf::strings::detail`; // bools: // diff --git a/cpp/src/io/parquet/writer_impl.hpp b/cpp/src/io/parquet/writer_impl.hpp index 99b6410c44d..e71cd063e70 100644 --- a/cpp/src/io/parquet/writer_impl.hpp +++ b/cpp/src/io/parquet/writer_impl.hpp @@ -85,8 +85,8 @@ class writer::impl { * @param filepath Filepath if storing dataset to a file * @param options Settings for controlling behavior * @param mode Option to write at once or in chunks - * @param mr Device memory resource to use for device memory allocation * @param stream CUDA stream used for device memory operations and kernel launches + * @param mr Device memory resource to use for device memory allocation */ explicit impl(std::unique_ptr sink, chunked_parquet_writer_options const& options, diff --git a/cpp/src/partitioning/round_robin.cu b/cpp/src/partitioning/round_robin.cu index 80beb6e715c..98ab713bfa2 100644 --- a/cpp/src/partitioning/round_robin.cu +++ b/cpp/src/partitioning/round_robin.cu @@ -68,8 +68,8 @@ namespace { * @Param[in] input The input table to be round-robin partitioned * @Param[in] num_partitions Number of partitions for the table * @Param[in] start_partition Index of the 1st partition - * @Param[in] mr Device memory resource used to allocate the returned table's device memory * @Param[in] stream CUDA stream used for device memory operations and kernel launches. + * @Param[in] mr Device memory resource used to allocate the returned table's device memory * * @Returns A std::pair consisting of a unique_ptr to the partitioned table and the partition * offsets for each partition within the table diff --git a/cpp/src/reductions/minmax.cu b/cpp/src/reductions/minmax.cu index bf515342afb..59a614664c9 100644 --- a/cpp/src/reductions/minmax.cu +++ b/cpp/src/reductions/minmax.cu @@ -57,15 +57,14 @@ struct minmax_pair { * * @tparam Op Binary operator functor * @tparam InputIterator Input iterator Type + * @tparam OutputType Output scalar type * @param d_in input iterator * @param num_items number of items to reduce * @param binary_op binary operator used to reduce - * @param mr Device resource used for result allocation * @param stream CUDA stream to run kernels on. * @return rmm::device_scalar */ -template ::type> rmm::device_scalar reduce_device(InputIterator d_in, @@ -155,16 +154,19 @@ struct minmax_functor { if (col.has_nulls()) { auto pair_to_minmax = thrust::make_transform_iterator( make_pair_iterator(*device_col), create_minmax_with_nulls{}); - return reduce_device(pair_to_minmax, col.size(), minmax_binary_op{}, stream); + return reduce_device(pair_to_minmax, col.size(), minmax_binary_op{}, stream); } else { auto col_to_minmax = thrust::make_transform_iterator(device_col->begin(), create_minmax{}); - return reduce_device(col_to_minmax, col.size(), minmax_binary_op{}, stream); + return reduce_device(col_to_minmax, col.size(), minmax_binary_op{}, stream); } } /** * @brief Functor to copy a minmax_pair result to individual scalar instances. + * + * @tparam T type of the data + * @tparam ResultType result type to assign min, max to minmax_pair */ template > struct assign_min_max { @@ -246,6 +248,11 @@ struct minmax_functor { } // namespace +/** + * @copydoc cudf::minmax + * + * @param stream CUDA stream used for device memory operations and kernel launches. + */ std::pair, std::unique_ptr> minmax( cudf::column_view const& col, rmm::cuda_stream_view stream, rmm::mr::device_memory_resource* mr) { @@ -260,9 +267,6 @@ std::pair, std::unique_ptr> minmax( } } // namespace detail -/** - * @copydoc cudf::minmax - */ std::pair, std::unique_ptr> minmax( const column_view& col, rmm::mr::device_memory_resource* mr) { diff --git a/cpp/src/reductions/simple.cuh b/cpp/src/reductions/simple.cuh index e0dc219b767..c8345a30f79 100644 --- a/cpp/src/reductions/simple.cuh +++ b/cpp/src/reductions/simple.cuh @@ -41,8 +41,8 @@ namespace simple { * @tparam Op the operator of cudf::reduction::op:: * @param col Input column of data to reduce - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream Used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Output scalar in device memory */ template @@ -76,10 +76,10 @@ std::unique_ptr simple_reduction(column_view const& col, * * @tparam DecimalXX The `decimal32` or `decimal64` type * @tparam Op The operator of cudf::reduction::op:: + * * @param col Input column of data to reduce - - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream Used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Output scalar in device memory */ template @@ -124,10 +124,10 @@ std::unique_ptr fixed_point_reduction(column_view const& col, * @tparam ElementType The key type of the input dictionary column. * @tparam ResultType The output data-type for the resulting scalar * @tparam Op The operator of cudf::reduction::op:: - + * * @param col Input dictionary column of data to reduce - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream Used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory * @return Output scalar in device memory */ template @@ -376,8 +376,8 @@ struct element_type_dispatcher { * @tparam ElementType The input column type or key type. * @param col Input column (must be numeric) * @param output_type Requested type of the scalar result - * @param mr Device memory resource used to allocate the returned scalar's device memory * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned scalar's device memory */ template ()>* = nullptr> diff --git a/cpp/src/strings/find.cu b/cpp/src/strings/find.cu index 57d5d6afc75..8e40b7ce7e8 100644 --- a/cpp/src/strings/find.cu +++ b/cpp/src/strings/find.cu @@ -47,8 +47,8 @@ namespace { * @param start First character position to start the search. * @param stop Last character position (exclusive) to end the search. * @param pfn Functor used for locating `target` in each string. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New integer column with character position values. */ template @@ -172,8 +172,8 @@ namespace { * @param strings Column of strings to check for target. * @param target UTF-8 encoded string to check in strings column. * @param pfn Returns bool value if target is found in the given string. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New BOOL column. */ template @@ -233,8 +233,8 @@ std::unique_ptr contains_fn(strings_column_view const& strings, * @param strings Column of strings to check for `targets[i]`. * @param targets Column of strings to be checked in `strings[i]``. * @param pfn Returns bool value if target is found in the given string. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New BOOL column. */ template diff --git a/cpp/src/strings/substring.cu b/cpp/src/strings/substring.cu index 72359ada8c9..82759a6c73f 100644 --- a/cpp/src/strings/substring.cu +++ b/cpp/src/strings/substring.cu @@ -192,8 +192,8 @@ struct substring_from_fn { * @param null_count Number of nulls for the output column. * @param starts Start positions index iterator. * @param stops Stop positions index iterator. - * @param mr Device memory resource used to allocate the returned column's device memory. * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned column's device memory. */ std::unique_ptr compute_substrings_from_fn(column_device_view const& d_column, size_type null_count, diff --git a/cpp/src/unary/cast_ops.cu b/cpp/src/unary/cast_ops.cu index d01d0a8cbbc..c316b2c6f4e 100644 --- a/cpp/src/unary/cast_ops.cu +++ b/cpp/src/unary/cast_ops.cu @@ -163,8 +163,8 @@ struct device_cast { * @tparam T Type of the `fixed_point` column_view (`decimal32` or `decimal64`) * @param input Input `column_view` * @param scale `scale` of the returned `column` - * @param mr Device memory resource used to allocate the returned column's device memory * @param stream CUDA stream used for device memory operations and kernel launches + * @param mr Device memory resource used to allocate the returned column's device memory * * @return std::unique_ptr Returned column with new @p scale */