From c19dac665c0c59e2a5668a406bd34786aa559e69 Mon Sep 17 00:00:00 2001 From: Karthikeyan Natarajan Date: Tue, 24 May 2022 02:40:49 +0530 Subject: [PATCH 1/6] add missing doc to strings/ headers --- .../cudf/strings/char_types/char_types.hpp | 10 +++- cpp/include/cudf/strings/json.hpp | 6 ++- cpp/include/cudf/strings/string_view.cuh | 2 + cpp/include/cudf/strings/string_view.hpp | 48 ++++++++++++++++++- .../cudf/strings/strings_column_view.hpp | 37 ++++++++++---- 5 files changed, 91 insertions(+), 12 deletions(-) diff --git a/cpp/include/cudf/strings/char_types/char_types.hpp b/cpp/include/cudf/strings/char_types/char_types.hpp index 04d65065bd3..a5a90f74c21 100644 --- a/cpp/include/cudf/strings/char_types/char_types.hpp +++ b/cpp/include/cudf/strings/char_types/char_types.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,11 +51,19 @@ enum string_character_types : uint32_t { /** * @brief OR operator for combining string_character_types + * + * @param lhs left-hand side of OR operation + * @param rhs right-hand side of OR operation + * @return combined string_character_types */ string_character_types operator|(string_character_types lhs, string_character_types rhs); /** * @brief Compound assignment OR operator for combining string_character_types + * + * @param lhs left-hand side of OR operation + * @param rhs right-hand side of OR operation + * @return Reference to `lhs` after combining `lhs` and `rhs` */ string_character_types& operator|=(string_character_types& lhs, string_character_types rhs); diff --git a/cpp/include/cudf/strings/json.hpp b/cpp/include/cudf/strings/json.hpp index f6645f2e029..2b66bcb807e 100644 --- a/cpp/include/cudf/strings/json.hpp +++ b/cpp/include/cudf/strings/json.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021, NVIDIA CORPORATION. + * Copyright (c) 2021-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,6 +47,8 @@ class get_json_object_options { /** * @brief Returns true/false depending on whether single-quotes for representing strings * are allowed. + * + * @return true if single-quotes are allowed, false otherwise. */ [[nodiscard]] CUDF_HOST_DEVICE inline bool get_allow_single_quotes() const { @@ -74,6 +76,8 @@ class get_json_object_options { * Output = b * * @endcode + * + * @return true if individually returned string values have their quotes stripped. */ [[nodiscard]] CUDF_HOST_DEVICE inline bool get_strip_quotes_from_single_strings() const { diff --git a/cpp/include/cudf/strings/string_view.cuh b/cpp/include/cudf/strings/string_view.cuh index a486a5a765c..57d082cf11c 100644 --- a/cpp/include/cudf/strings/string_view.cuh +++ b/cpp/include/cudf/strings/string_view.cuh @@ -112,6 +112,7 @@ __device__ inline size_type string_view::length() const return _length; } +// @cond // this custom iterator knows about UTF8 encoding __device__ inline string_view::const_iterator::const_iterator(const string_view& str, size_type pos) : p{str.data()}, bytes{str.size_bytes()}, char_pos{pos}, byte_pos{str.byte_offset(pos)} @@ -243,6 +244,7 @@ __device__ inline string_view::const_iterator string_view::end() const { return const_iterator(*this, length()); } +// @endcond __device__ inline char_utf8 string_view::operator[](size_type pos) const { diff --git a/cpp/include/cudf/strings/string_view.hpp b/cpp/include/cudf/strings/string_view.hpp index 0c76f7d818d..fbe2253bf25 100644 --- a/cpp/include/cudf/strings/string_view.hpp +++ b/cpp/include/cudf/strings/string_view.hpp @@ -50,19 +50,27 @@ class string_view { public: /** * @brief Return the number of bytes in this string + * + * @return The number of bytes in this string */ CUDF_HOST_DEVICE [[nodiscard]] inline size_type size_bytes() const { return _bytes; } /** * @brief Return the number of characters in this string + * + * @return The number of characters in this string */ __device__ [[nodiscard]] inline size_type length() const; /** * @brief Return a pointer to the internal device array + * + * @return A pointer to the internal device array */ CUDF_HOST_DEVICE [[nodiscard]] inline const char* data() const { return _data; } /** * @brief Return true if string has no characters + * + * @return true if string has no characters */ CUDF_HOST_DEVICE [[nodiscard]] inline bool empty() const { return size_bytes() == 0; } @@ -70,6 +78,7 @@ class string_view { * @brief Handy iterator for navigating through encoded characters. */ class const_iterator { + /// @cond public: using difference_type = ptrdiff_t; using value_type = char_utf8; @@ -104,14 +113,19 @@ class string_view { size_type bytes{}; size_type char_pos{}; size_type byte_pos{}; + /// @endcond }; /** * @brief Return new iterator pointing to the beginning of this string + * + * @return new iterator pointing to the beginning of this string */ __device__ [[nodiscard]] inline const_iterator begin() const; /** * @brief Return new iterator pointing past the end of this string + * + * @return new iterator pointing past the end of this string */ __device__ [[nodiscard]] inline const_iterator end() const; @@ -119,12 +133,14 @@ class string_view { * @brief Return single UTF-8 character at the given character position * * @param pos Character position + * @return UTF-8 character at the given character position */ __device__ inline char_utf8 operator[](size_type pos) const; /** * @brief Return the byte offset from data() for a given character position * * @param pos Character position + * @return Byte offset from data() for a given character position */ __device__ [[nodiscard]] inline size_type byte_offset(size_type pos) const; @@ -160,26 +176,44 @@ class string_view { /** * @brief Returns true if rhs matches this string exactly. + * + * @param rhs Target string to compare with this string. + * @return true if rhs matches this string exactly */ __device__ inline bool operator==(const string_view& rhs) const; /** * @brief Returns true if rhs does not match this string. + * + * @param rhs Target string to compare with this string. + * @return true if rhs does not match this string */ __device__ inline bool operator!=(const string_view& rhs) const; /** * @brief Returns true if this string is ordered before rhs. + * + * @param rhs Target string to compare with this string. + * @return true if this string is ordered before rhs */ __device__ inline bool operator<(const string_view& rhs) const; /** * @brief Returns true if rhs is ordered before this string. + * + * @param rhs Target string to compare with this string. + * @return true if rhs is ordered before this string */ __device__ inline bool operator>(const string_view& rhs) const; /** * @brief Returns true if this string matches or is ordered before rhs. + * + * @param rhs Target string to compare with this string. + * @return true if this string matches or is ordered before rhs */ __device__ inline bool operator<=(const string_view& rhs) const; /** * @brief Returns true if rhs matches or is ordered before this string. + * + * @param rhs Target string to compare with this string. + * @return true if rhs matches or is ordered before this string */ __device__ inline bool operator>=(const string_view& rhs) const; @@ -313,10 +347,20 @@ class string_view { { } - string_view(const string_view&) = default; - string_view(string_view&&) = default; + string_view(const string_view&) = default; ///< Copy constructor + string_view(string_view&&) = default; ///< Move constructor ~string_view() = default; + /** + * @brief Copy assignment operator + * + * @return Reference to this instance + */ string_view& operator=(const string_view&) = default; + /** + * @brief Move assignment operator + * + * @return Reference to this instance (after transferring ownership) + */ string_view& operator=(string_view&&) = default; private: diff --git a/cpp/include/cudf/strings/strings_column_view.hpp b/cpp/include/cudf/strings/strings_column_view.hpp index aab898932de..e617dbde024 100644 --- a/cpp/include/cudf/strings/strings_column_view.hpp +++ b/cpp/include/cudf/strings/strings_column_view.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,15 +35,30 @@ namespace cudf { */ class strings_column_view : private column_view { public: + /** + * @brief Construct a new strings column view object from a column view.s + * + * @param strings_column The column view to wrap. + */ strings_column_view(column_view strings_column); - strings_column_view(strings_column_view&& strings_view) = default; - strings_column_view(const strings_column_view& strings_view) = default; - ~strings_column_view() = default; + strings_column_view(strings_column_view&&) = default; ///< Move constructor + strings_column_view(strings_column_view const&) = default; ///< Copy constructor + ~strings_column_view() = default; + /** + * @brief Copy assignment operator + * + * @return Reference to this instance + */ strings_column_view& operator=(strings_column_view const&) = default; + /** + * @brief Move assignment operator + * + * @return Reference to this instance (after transferring ownership) + */ strings_column_view& operator=(strings_column_view&&) = default; - static constexpr size_type offsets_column_index{0}; - static constexpr size_type chars_column_index{1}; + static constexpr size_type offsets_column_index{0}; ///< Child index of the offsets column + static constexpr size_type chars_column_index{1}; ///< Child index of the characters column using column_view::has_nulls; using column_view::is_empty; @@ -52,11 +67,13 @@ class strings_column_view : private column_view { using column_view::offset; using column_view::size; - using offset_iterator = offset_type const*; - using chars_iterator = char const*; + using offset_iterator = offset_type const*; ///< offsets iterator type + using chars_iterator = char const*; ///< character iterator type /** * @brief Returns the parent column. + * + * @return The parents column */ [[nodiscard]] column_view parent() const; @@ -64,6 +81,7 @@ class strings_column_view : private column_view { * @brief Returns the internal column of offsets * * @throw cudf::logic error if this is an empty column + * @return The offsets column */ [[nodiscard]] column_view offsets() const; @@ -89,6 +107,7 @@ class strings_column_view : private column_view { * @brief Returns the internal column of chars * * @throw cudf::logic error if this is an empty column + * @return The chars column */ [[nodiscard]] column_view chars() const; @@ -97,6 +116,8 @@ class strings_column_view : private column_view { * * This accounts for empty columns but does not reflect a sliced parent column * view (i.e.: non-zero offset or reduced row count). + * + * @return Number of bytes in the chars child column */ [[nodiscard]] size_type chars_size() const noexcept; From 771cd46a57856f4c6ca7956a4b20f59541f1b1d3 Mon Sep 17 00:00:00 2001 From: Karthikeyan Natarajan Date: Tue, 24 May 2022 22:08:25 +0530 Subject: [PATCH 2/6] remove . dot at end of @param --- cpp/include/cudf/strings/attributes.hpp | 14 ++-- cpp/include/cudf/strings/capitalize.hpp | 12 ++-- cpp/include/cudf/strings/case.hpp | 14 ++-- .../cudf/strings/char_types/char_types.hpp | 16 ++--- cpp/include/cudf/strings/combine.hpp | 36 +++++----- cpp/include/cudf/strings/contains.hpp | 24 +++---- .../cudf/strings/convert/convert_booleans.hpp | 16 ++--- .../cudf/strings/convert/convert_datetime.hpp | 20 +++--- .../strings/convert/convert_durations.hpp | 14 ++-- .../strings/convert/convert_fixed_point.hpp | 18 ++--- .../cudf/strings/convert/convert_floats.hpp | 16 ++--- .../cudf/strings/convert/convert_integers.hpp | 36 +++++----- .../cudf/strings/convert/convert_ipv4.hpp | 14 ++-- .../cudf/strings/convert/convert_lists.hpp | 8 +-- .../cudf/strings/convert/convert_urls.hpp | 10 +-- cpp/include/cudf/strings/detail/combine.hpp | 6 +- .../cudf/strings/detail/concatenate.hpp | 8 +-- .../strings/detail/convert/fixed_point.cuh | 2 +- .../cudf/strings/detail/converters.hpp | 24 +++---- .../cudf/strings/detail/copy_if_else.cuh | 12 ++-- .../cudf/strings/detail/copy_range.cuh | 6 +- cpp/include/cudf/strings/detail/copying.hpp | 22 +++--- cpp/include/cudf/strings/detail/fill.hpp | 14 ++-- cpp/include/cudf/strings/detail/gather.cuh | 56 +++++++-------- cpp/include/cudf/strings/detail/merge.cuh | 10 +-- cpp/include/cudf/strings/detail/replace.hpp | 16 ++--- cpp/include/cudf/strings/detail/scatter.cuh | 6 +- cpp/include/cudf/strings/detail/utf8.hpp | 8 +-- cpp/include/cudf/strings/detail/utilities.cuh | 32 ++++----- cpp/include/cudf/strings/detail/utilities.hpp | 12 ++-- cpp/include/cudf/strings/extract.hpp | 16 ++--- cpp/include/cudf/strings/find.hpp | 58 ++++++++-------- cpp/include/cudf/strings/find_multiple.hpp | 6 +- cpp/include/cudf/strings/findall.hpp | 16 ++--- cpp/include/cudf/strings/json.hpp | 8 +-- cpp/include/cudf/strings/padding.hpp | 16 ++--- cpp/include/cudf/strings/repeat_strings.hpp | 22 +++--- cpp/include/cudf/strings/replace.hpp | 30 ++++---- cpp/include/cudf/strings/replace_re.hpp | 30 ++++---- cpp/include/cudf/strings/split/partition.hpp | 14 ++-- cpp/include/cudf/strings/split/split.hpp | 34 +++++----- cpp/include/cudf/strings/split/split_re.hpp | 32 ++++----- cpp/include/cudf/strings/string.cuh | 4 +- cpp/include/cudf/strings/string_view.cuh | 4 +- cpp/include/cudf/strings/string_view.hpp | 68 +++++++++---------- .../cudf/strings/strings_column_view.hpp | 4 +- cpp/include/cudf/strings/strip.hpp | 8 +-- cpp/include/cudf/strings/substring.hpp | 36 +++++----- cpp/include/cudf/strings/translate.hpp | 16 ++--- cpp/include/cudf/strings/wrap.hpp | 6 +- 50 files changed, 465 insertions(+), 465 deletions(-) diff --git a/cpp/include/cudf/strings/attributes.hpp b/cpp/include/cudf/strings/attributes.hpp index 5babe3f3fa0..a4be3ee54c8 100644 --- a/cpp/include/cudf/strings/attributes.hpp +++ b/cpp/include/cudf/strings/attributes.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,8 +39,8 @@ namespace strings { * * Any null string will result in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New INT32 column with lengths for each string. */ std::unique_ptr count_characters( @@ -57,8 +57,8 @@ std::unique_ptr count_characters( * * Any null string will result in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New INT32 column with the number of bytes for each string. */ std::unique_ptr count_bytes( @@ -77,8 +77,8 @@ std::unique_ptr count_bytes( * * Any null string is ignored. No null entries will appear in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New INT32 column with code point integer values for each character. */ std::unique_ptr code_points( diff --git a/cpp/include/cudf/strings/capitalize.hpp b/cpp/include/cudf/strings/capitalize.hpp index dbf8ef54e3e..042e367150f 100644 --- a/cpp/include/cudf/strings/capitalize.hpp +++ b/cpp/include/cudf/strings/capitalize.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021, NVIDIA CORPORATION. + * Copyright (c) 2020-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -50,8 +50,8 @@ namespace strings { * * @throw cudf::logic_error if `delimiter.is_valid()` is `false`. * - * @param input String column. - * @param delimiters Characters for identifying words to capitalize. + * @param input String column + * @param delimiters Characters for identifying words to capitalize * @param mr Device memory resource used to allocate the returned column's device memory * @return Column of strings capitalized from the input column. */ @@ -81,8 +81,8 @@ std::unique_ptr capitalize( * * Any null string entries return corresponding null output column entries. * - * @param input String column. - * @param sequence_type The character type that is used when identifying words. + * @param input String column + * @param sequence_type The character type that is used when identifying words * @param mr Device memory resource used to allocate the returned column's device memory * @return Column of titled strings. */ @@ -110,7 +110,7 @@ std::unique_ptr title( * * Any null string entries result in corresponding null output column entries. * - * @param input String column. + * @param input String column * @param mr Device memory resource used to allocate the returned column's device memory * @return Column of type BOOL8. */ diff --git a/cpp/include/cudf/strings/case.hpp b/cpp/include/cudf/strings/case.hpp index bf746d80b3b..89af0171cd3 100644 --- a/cpp/include/cudf/strings/case.hpp +++ b/cpp/include/cudf/strings/case.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,8 +35,8 @@ namespace strings { * * Any null entries create null entries in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of strings with characters converted. */ std::unique_ptr to_lower( @@ -52,8 +52,8 @@ std::unique_ptr to_lower( * * Any null entries create null entries in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of strings with characters converted. */ std::unique_ptr to_upper( @@ -70,8 +70,8 @@ std::unique_ptr to_upper( * * Any null entries create null entries in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of strings with characters converted. */ std::unique_ptr swapcase( diff --git a/cpp/include/cudf/strings/char_types/char_types.hpp b/cpp/include/cudf/strings/char_types/char_types.hpp index a5a90f74c21..3c0c99d6f11 100644 --- a/cpp/include/cudf/strings/char_types/char_types.hpp +++ b/cpp/include/cudf/strings/char_types/char_types.hpp @@ -90,12 +90,12 @@ string_character_types& operator|=(string_character_types& lhs, string_character * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param types The character types to check in each string. - * @param verify_types Only verify against these character types. + * @param strings Strings instance for this operation + * @param types The character types to check in each string + * @param verify_types Only verify against these character types * Default `ALL_TYPES` means return `true` * iff all characters match `types`. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr all_characters_of_type( @@ -133,13 +133,13 @@ std::unique_ptr all_characters_of_type( * @throw cudf::logic_error if neither or both `types_to_remove` and * `types_to_keep` are set to `ALL_TYPES`. * - * @param strings Strings instance for this operation. - * @param types_to_remove The character types to check in each string. + * @param strings Strings instance for this operation + * @param types_to_remove The character types to check in each string * Use `ALL_TYPES` here to specify `types_to_keep` instead. - * @param replacement The replacement character to use when removing characters. + * @param replacement The replacement character to use when removing characters * @param types_to_keep Default `ALL_TYPES` means all characters of * `types_to_remove` will be filtered. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr filter_characters_of_type( diff --git a/cpp/include/cudf/strings/combine.hpp b/cpp/include/cudf/strings/combine.hpp index 32f8d482a34..1f65ac13600 100644 --- a/cpp/include/cudf/strings/combine.hpp +++ b/cpp/include/cudf/strings/combine.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -64,12 +64,12 @@ enum class output_if_empty_list { * * @throw cudf::logic_error if separator is not valid. * - * @param strings Strings for this operation. - * @param separator String that should inserted between each string. + * @param strings Strings for this operation + * @param separator String that should inserted between each string * Default is an empty string. - * @param narep String that should represent any null strings found. + * @param narep String that should represent any null strings found * Default of invalid-scalar will ignore any null entries. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column containing one string. */ std::unique_ptr join_strings( @@ -125,7 +125,7 @@ std::unique_ptr join_strings( * @throw cudf::logic_error if the number of rows from @p separators and @p strings_columns * do not match * - * @param strings_columns List of strings columns to concatenate. + * @param strings_columns List of strings columns to concatenate * @param separators Strings column that provides the separator for a given row * @param separator_narep String that should be used in place of a null separator for a given * row. Default of invalid-scalar means no row separator value replacements. @@ -135,7 +135,7 @@ std::unique_ptr join_strings( * Default is an invalid string. * @param separate_nulls If YES, then the separator is included for null rows * if `col_narep` is valid. - * @param mr Resource for allocating device memory. + * @param mr Resource for allocating device memory * @return New column with concatenated results. */ std::unique_ptr concatenate( @@ -182,14 +182,14 @@ std::unique_ptr concatenate( * @throw cudf::logic_error if separator is not valid. * @throw cudf::logic_error if only one column is specified * - * @param strings_columns List of string columns to concatenate. - * @param separator String that should inserted between each string from each row. + * @param strings_columns List of string columns to concatenate + * @param separator String that should inserted between each string from each row * Default is an empty string. * @param narep String that should be used in place of any null strings * found in any column. Default of invalid-scalar means any null entry in any column will * produces a null result for that row. - * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with concatenated results. */ std::unique_ptr concatenate( @@ -241,18 +241,18 @@ std::unique_ptr concatenate( * @throw cudf::logic_error if the number of rows from `separators` and `lists_strings_column` do * not match * - * @param lists_strings_column Column containing lists of strings to concatenate. - * @param separators Strings column that provides separators for concatenation. + * @param lists_strings_column Column containing lists of strings to concatenate + * @param separators Strings column that provides separators for concatenation * @param separator_narep String that should be used to replace null separator, default is an * invalid-scalar denoting that rows containing null separator will result in null string in * the corresponding output rows. * @param string_narep String that should be used to replace null strings in any non-null list row, * default is an invalid-scalar denoting that list rows containing null strings will result * in null string in the corresponding output rows. - * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid. + * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid * @param empty_list_policy if set to EMPTY_STRING, any input row that is an empty list will * result in an empty string. Otherwise, it will result in a null. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with concatenated results. */ std::unique_ptr join_list_elements( @@ -301,16 +301,16 @@ std::unique_ptr join_list_elements( * @throw cudf::logic_error if input column is not lists of strings column. * @throw cudf::logic_error if separator is not valid. * - * @param lists_strings_column Column containing lists of strings to concatenate. + * @param lists_strings_column Column containing lists of strings to concatenate * @param separator String that should inserted between strings of each list row, default is an * empty string. * @param narep String that should be used to replace null strings in any non-null list row, default * is an invalid-scalar denoting that list rows containing null strings will result in null * string in the corresponding output rows. - * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid. + * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid * @param empty_list_policy if set to EMPTY_STRING, any input row that is an empty list will result * in an empty string. Otherwise, it will result in a null. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with concatenated results. */ std::unique_ptr join_list_elements( diff --git a/cpp/include/cudf/strings/contains.hpp b/cpp/include/cudf/strings/contains.hpp index 5b8b2f56bae..507322a66b5 100644 --- a/cpp/include/cudf/strings/contains.hpp +++ b/cpp/include/cudf/strings/contains.hpp @@ -43,10 +43,10 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param pattern Regex pattern to match to each string. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param pattern Regex pattern to match to each string + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr contains_re( @@ -70,10 +70,10 @@ std::unique_ptr contains_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param pattern Regex pattern to match to each string. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param pattern Regex pattern to match to each string + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr matches_re( @@ -97,10 +97,10 @@ std::unique_ptr matches_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param pattern Regex pattern to match within each string. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param pattern Regex pattern to match within each string + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned column's device memory * @return New INT32 column with counts for each string. */ std::unique_ptr count_re( diff --git a/cpp/include/cudf/strings/convert/convert_booleans.hpp b/cpp/include/cudf/strings/convert/convert_booleans.hpp index 644068a62f3..459b0f837b4 100644 --- a/cpp/include/cudf/strings/convert/convert_booleans.hpp +++ b/cpp/include/cudf/strings/convert/convert_booleans.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,9 +33,9 @@ namespace strings { * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation. - * @param true_string String to expect for true. Non-matching strings are false. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param true_string String to expect for true. Non-matching strings are false + * @param mr Device memory resource used to allocate the returned column's device memory * @return New BOOL8 column converted from strings. */ std::unique_ptr to_booleans( @@ -51,10 +51,10 @@ std::unique_ptr to_booleans( * * @throw cudf::logic_error if the input column is not BOOL8 type. * - * @param booleans Boolean column to convert. - * @param true_string String to use for true in the output column. - * @param false_string String to use for false in the output column. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param booleans Boolean column to convert + * @param true_string String to use for true in the output column + * @param false_string String to use for false in the output column + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr from_booleans( diff --git a/cpp/include/cudf/strings/convert/convert_datetime.hpp b/cpp/include/cudf/strings/convert/convert_datetime.hpp index 3c3e40a1f0e..6118639c12a 100644 --- a/cpp/include/cudf/strings/convert/convert_datetime.hpp +++ b/cpp/include/cudf/strings/convert/convert_datetime.hpp @@ -65,10 +65,10 @@ namespace strings { * * @throw cudf::logic_error if timestamp_type is not a timestamp type. * - * @param strings Strings instance for this operation. - * @param timestamp_type The timestamp type used for creating the output column. - * @param format String specifying the timestamp format in strings. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param timestamp_type The timestamp type used for creating the output column + * @param format String specifying the timestamp format in strings + * @param mr Device memory resource used to allocate the returned column's device memory * @return New datetime column. */ std::unique_ptr to_timestamps( @@ -108,9 +108,9 @@ std::unique_ptr to_timestamps( * This will return a column of type BOOL8 where a `true` row indicates the corresponding * input string can be parsed correctly with the given format. * - * @param strings Strings instance for this operation. - * @param format String specifying the timestamp format in strings. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param format String specifying the timestamp format in strings + * @param mr Device memory resource used to allocate the returned column's device memory * @return New BOOL8 column. */ std::unique_ptr is_timestamp( @@ -215,12 +215,12 @@ std::unique_ptr is_timestamp( * @throw cudf::logic_error if the `format` string is empty * @throw cudf::logic_error if `names.size()` is an invalid size. Must be 0 or 40 strings. * - * @param timestamps Timestamp values to convert. - * @param format The string specifying output format. + * @param timestamps Timestamp values to convert + * @param format The string specifying output format * Default format is "%Y-%m-%dT%H:%M:%SZ". * @param names The string names to use for weekdays ("%a", "%A") and months ("%b", "%B") * Default is an empty `strings_column_view`. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with formatted timestamps. */ std::unique_ptr from_timestamps( diff --git a/cpp/include/cudf/strings/convert/convert_durations.hpp b/cpp/include/cudf/strings/convert/convert_durations.hpp index ac96a2c2fc6..396758109f2 100644 --- a/cpp/include/cudf/strings/convert/convert_durations.hpp +++ b/cpp/include/cudf/strings/convert/convert_durations.hpp @@ -63,10 +63,10 @@ namespace strings { * * @throw cudf::logic_error if duration_type is not a duration type. * - * @param strings Strings instance for this operation. - * @param duration_type The duration type used for creating the output column. - * @param format String specifying the duration format in strings. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param duration_type The duration type used for creating the output column + * @param format String specifying the duration format in strings + * @param mr Device memory resource used to allocate the returned column's device memory * @return New duration column. */ std::unique_ptr to_durations( @@ -113,10 +113,10 @@ std::unique_ptr to_durations( * * @throw cudf::logic_error if `durations` column parameter is not a duration type. * - * @param durations Duration values to convert. - * @param format The string specifying output format. + * @param durations Duration values to convert + * @param format The string specifying output format * Default format is ""%d days %H:%M:%S". - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with formatted durations. */ std::unique_ptr from_durations( diff --git a/cpp/include/cudf/strings/convert/convert_fixed_point.hpp b/cpp/include/cudf/strings/convert/convert_fixed_point.hpp index 5fe5c880f9d..5805f5da496 100644 --- a/cpp/include/cudf/strings/convert/convert_fixed_point.hpp +++ b/cpp/include/cudf/strings/convert/convert_fixed_point.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021, NVIDIA CORPORATION. + * Copyright (c) 2021-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,9 +51,9 @@ namespace strings { * * @throw cudf::logic_error if `output_type` is not a fixed-point decimal type. * - * @param input Strings instance for this operation. - * @param output_type Type of fixed-point column to return including the scale value. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Strings instance for this operation + * @param output_type Type of fixed-point column to return including the scale value + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of `output_type`. */ std::unique_ptr to_fixed_point( @@ -81,8 +81,8 @@ std::unique_ptr to_fixed_point( * * @throw cudf::logic_error if the `input` column is not a fixed-point decimal type. * - * @param input Fixed-point column to convert. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Fixed-point column to convert + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr from_fixed_point( @@ -109,9 +109,9 @@ std::unique_ptr from_fixed_point( * * @throw cudf::logic_error if the `decimal_type` is not a fixed-point decimal type. * - * @param input Strings instance for this operation. - * @param decimal_type Fixed-point type (with scale) used only for checking overflow. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Strings instance for this operation + * @param decimal_type Fixed-point type (with scale) used only for checking overflow + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr is_fixed_point( diff --git a/cpp/include/cudf/strings/convert/convert_floats.hpp b/cpp/include/cudf/strings/convert/convert_floats.hpp index d1e00b36f6f..89962faa3bd 100644 --- a/cpp/include/cudf/strings/convert/convert_floats.hpp +++ b/cpp/include/cudf/strings/convert/convert_floats.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021, NVIDIA CORPORATION. + * Copyright (c) 2021-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -37,9 +37,9 @@ namespace strings { * * @throw cudf::logic_error if output_type is not float type. * - * @param strings Strings instance for this operation. - * @param output_type Type of float numeric column to return. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param output_type Type of float numeric column to return + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with floats converted from strings. */ std::unique_ptr to_floats( @@ -60,8 +60,8 @@ std::unique_ptr to_floats( * * @throw cudf::logic_error if floats column is not float type. * - * @param floats Numeric column to convert. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param floats Numeric column to convert + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with floats as strings. */ std::unique_ptr from_floats( @@ -84,8 +84,8 @@ std::unique_ptr from_floats( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr is_float( diff --git a/cpp/include/cudf/strings/convert/convert_integers.hpp b/cpp/include/cudf/strings/convert/convert_integers.hpp index 17430d3eafe..ea03c027662 100644 --- a/cpp/include/cudf/strings/convert/convert_integers.hpp +++ b/cpp/include/cudf/strings/convert/convert_integers.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021, NVIDIA CORPORATION. + * Copyright (c) 2021-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -44,9 +44,9 @@ namespace strings { * * @throw cudf::logic_error if output_type is not integral type. * - * @param strings Strings instance for this operation. - * @param output_type Type of integer numeric column to return. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param output_type Type of integer numeric column to return + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with integers converted from strings. */ std::unique_ptr to_integers( @@ -65,8 +65,8 @@ std::unique_ptr to_integers( * * @throw cudf::logic_error if integers column is not integral type. * - * @param integers Numeric column to convert. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param integers Numeric column to convert + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with integers as strings. */ std::unique_ptr from_integers( @@ -92,8 +92,8 @@ std::unique_ptr from_integers( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr is_integer( @@ -122,9 +122,9 @@ std::unique_ptr is_integer( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param int_type Integer type used for checking underflow and overflow. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param int_type Integer type used for checking underflow and overflow + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr is_integer( @@ -150,9 +150,9 @@ std::unique_ptr is_integer( * * @throw cudf::logic_error if output_type is not integral type. * - * @param strings Strings instance for this operation. - * @param output_type Type of integer numeric column to return. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param output_type Type of integer numeric column to return + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with integers converted from strings. */ std::unique_ptr hex_to_integers( @@ -177,8 +177,8 @@ std::unique_ptr hex_to_integers( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr is_hex( @@ -208,8 +208,8 @@ std::unique_ptr is_hex( * * @throw cudf::logic_error if the input column is not integral type. * - * @param input Integer column to convert to hex. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Integer column to convert to hex + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with hexadecimal characters. */ std::unique_ptr integers_to_hex( diff --git a/cpp/include/cudf/strings/convert/convert_ipv4.hpp b/cpp/include/cudf/strings/convert/convert_ipv4.hpp index 80e3c89be2d..667660d884a 100644 --- a/cpp/include/cudf/strings/convert/convert_ipv4.hpp +++ b/cpp/include/cudf/strings/convert/convert_ipv4.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -46,8 +46,8 @@ namespace strings { * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New INT64 column converted from strings. */ std::unique_ptr ipv4_to_integers( @@ -69,8 +69,8 @@ std::unique_ptr ipv4_to_integers( * * @throw cudf::logic_error if the input column is not INT64 type. * - * @param integers Integer (INT64) column to convert. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param integers Integer (INT64) column to convert + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr integers_to_ipv4( @@ -94,8 +94,8 @@ std::unique_ptr integers_to_ipv4( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of boolean results for each string. */ std::unique_ptr is_ipv4( diff --git a/cpp/include/cudf/strings/convert/convert_lists.hpp b/cpp/include/cudf/strings/convert/convert_lists.hpp index 91b0e533f71..8b7cbdf093a 100644 --- a/cpp/include/cudf/strings/convert/convert_lists.hpp +++ b/cpp/include/cudf/strings/convert/convert_lists.hpp @@ -48,10 +48,10 @@ namespace strings { * * @throw cudf::logic_error if the input column is not a LIST type with a STRING child. * - * @param input Lists column to format. - * @param na_rep Replacement string for null elements. - * @param separators Strings to use for enclosing list components and separating elements. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Lists column to format + * @param na_rep Replacement string for null elements + * @param separators Strings to use for enclosing list components and separating elements + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr format_list_column( diff --git a/cpp/include/cudf/strings/convert/convert_urls.hpp b/cpp/include/cudf/strings/convert/convert_urls.hpp index a8893ab9dfd..a2f378539de 100644 --- a/cpp/include/cudf/strings/convert/convert_urls.hpp +++ b/cpp/include/cudf/strings/convert/convert_urls.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -37,8 +37,8 @@ namespace strings { * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr url_encode( @@ -58,8 +58,8 @@ std::unique_ptr url_encode( * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr url_decode( diff --git a/cpp/include/cudf/strings/detail/combine.hpp b/cpp/include/cudf/strings/detail/combine.hpp index 50f9a70e21c..34e80568508 100644 --- a/cpp/include/cudf/strings/detail/combine.hpp +++ b/cpp/include/cudf/strings/detail/combine.hpp @@ -31,7 +31,7 @@ namespace detail { * @copydoc concatenate(table_view const&,string_scalar const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr concatenate( table_view const& strings_columns, @@ -45,7 +45,7 @@ std::unique_ptr concatenate( * @copydoc join_strings(table_view const&,string_scalar const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr join_strings( strings_column_view const& strings, @@ -58,7 +58,7 @@ std::unique_ptr join_strings( * @copydoc join_list_elements(table_view const&,string_scalar const&,string_scalar * const&,separator_on_nulls,output_if_empty_list,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr join_list_elements(lists_column_view const& lists_strings_column, string_scalar const& separator, diff --git a/cpp/include/cudf/strings/detail/concatenate.hpp b/cpp/include/cudf/strings/detail/concatenate.hpp index 3512c05a586..ef6a107c7ea 100644 --- a/cpp/include/cudf/strings/detail/concatenate.hpp +++ b/cpp/include/cudf/strings/detail/concatenate.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,9 +36,9 @@ namespace detail { * r is now ['aa', 'bb', 'cc', 'dd', 'ee'] * ``` * - * @param columns List of string columns to concatenate. - * @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. + * @param columns List of string columns to concatenate + * @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/convert/fixed_point.cuh b/cpp/include/cudf/strings/detail/convert/fixed_point.cuh index 7af56f89449..dd0ae1b7846 100644 --- a/cpp/include/cudf/strings/detail/convert/fixed_point.cuh +++ b/cpp/include/cudf/strings/detail/convert/fixed_point.cuh @@ -121,7 +121,7 @@ __device__ thrust::optional parse_exponent(char const* iter, char const * @brief Converts the string in the range [iter, iter_end) into a decimal. * * @tparam DecimalType The decimal type to be returned - * @param iter The beginning of the string. Unless iter >= iter_end, iter is dereferenced + * @param iter The beginning of the string Unless iter >= iter_end, iter is dereferenced * @param iter_end The end of the characters to parse * @param scale The scale to be applied * @return diff --git a/cpp/include/cudf/strings/detail/converters.hpp b/cpp/include/cudf/strings/detail/converters.hpp index 3337815342c..3b442a526ed 100644 --- a/cpp/include/cudf/strings/detail/converters.hpp +++ b/cpp/include/cudf/strings/detail/converters.hpp @@ -28,7 +28,7 @@ namespace detail { /** * @copydoc to_integers(strings_column_view const&,data_type,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr to_integers(strings_column_view const& strings, data_type output_type, @@ -38,7 +38,7 @@ std::unique_ptr to_integers(strings_column_view const& strings, /** * @copydoc from_integers(strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr from_integers(column_view const& integers, rmm::cuda_stream_view stream, @@ -47,7 +47,7 @@ std::unique_ptr from_integers(column_view const& integers, /** * @copydoc to_floats(strings_column_view const&,data_type,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr to_floats(strings_column_view const& strings, data_type output_type, @@ -57,7 +57,7 @@ std::unique_ptr to_floats(strings_column_view const& strings, /** * @copydoc from_floats(strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr from_floats(column_view const& floats, rmm::cuda_stream_view stream, @@ -67,7 +67,7 @@ std::unique_ptr from_floats(column_view const& floats, * @copydoc to_booleans(strings_column_view const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr to_booleans(strings_column_view const& strings, string_scalar const& true_string, @@ -78,7 +78,7 @@ std::unique_ptr to_booleans(strings_column_view const& strings, * @copydoc from_booleans(strings_column_view const&,string_scalar const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr from_booleans(column_view const& booleans, string_scalar const& true_string, @@ -90,7 +90,7 @@ std::unique_ptr from_booleans(column_view const& booleans, * @copydoc to_timestamps(strings_column_view const&,data_type,std::string_view, * rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr to_timestamps(strings_column_view const& strings, data_type timestamp_type, @@ -102,7 +102,7 @@ std::unique_ptr to_timestamps(strings_column_view const& strings, * @copydoc from_timestamps(strings_column_view const&,std::string_view, * strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr from_timestamps(column_view const& timestamps, std::string_view format, @@ -114,7 +114,7 @@ std::unique_ptr from_timestamps(column_view const& timestamps, * @copydoc to_durations(strings_column_view const&,data_type,std::string_view, * rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr to_durations(strings_column_view const& strings, data_type duration_type, @@ -126,7 +126,7 @@ std::unique_ptr to_durations(strings_column_view const& strings, * @copydoc from_durations(strings_column_view const&,std::string_view. * rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr from_durations(column_view const& durations, std::string_view format, @@ -136,7 +136,7 @@ std::unique_ptr from_durations(column_view const& durations, /** * @copydoc to_fixed_point(strings_column_view const&,data_type,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr to_fixed_point(strings_column_view const& strings, data_type output_type, @@ -146,7 +146,7 @@ std::unique_ptr to_fixed_point(strings_column_view const& strings, /** * @copydoc from_fixed_point(strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches. + * @param stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr from_fixed_point(column_view const& integers, rmm::cuda_stream_view stream, diff --git a/cpp/include/cudf/strings/detail/copy_if_else.cuh b/cpp/include/cudf/strings/detail/copy_if_else.cuh index 79cec779e02..f755ee5dd7d 100644 --- a/cpp/include/cudf/strings/detail/copy_if_else.cuh +++ b/cpp/include/cudf/strings/detail/copy_if_else.cuh @@ -47,12 +47,12 @@ namespace detail { * `thrust::optional` where the `optional` has a value iff the element is valid. * @tparam Filter Functor that takes an index and returns a boolean. * - * @param lhs_begin Start of first set of data. Used when `filter_fn` returns true. - * @param lhs_end End of first set of data. - * @param rhs_begin Strings of second set of data. Used when `filter_fn` returns false. - * @param filter_fn Called to determine which iterator to use for a specific row. - * @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. + * @param lhs_begin Start of first set of data. Used when `filter_fn` returns true + * @param lhs_end End of first set of data + * @param rhs_begin Strings of second set of data. Used when `filter_fn` returns false + * @param filter_fn Called to determine which iterator to use for a specific row + * @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 e83f6dc0005..cfa3556d2e9 100644 --- a/cpp/include/cudf/strings/detail/copy_range.cuh +++ b/cpp/include/cudf/strings/detail/copy_range.cuh @@ -90,12 +90,12 @@ namespace detail { * @tparam SourceValidityIterator Iterator for retrieving source validities * @param source_value_begin Start of source value iterator * @param source_validity_begin Start of source validity iterator - * @param target The strings column to copy from outside the range. + * @param target The strings column to copy from outside the range * @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 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. + * @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/copying.hpp b/cpp/include/cudf/strings/detail/copying.hpp index 6083ebc4a62..3cec8809dc5 100644 --- a/cpp/include/cudf/strings/detail/copying.hpp +++ b/cpp/include/cudf/strings/detail/copying.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -40,12 +40,12 @@ namespace detail { * s2 is ["b", "c"] * @endcode * - * @param strings Strings instance for this operation. - * @param start Index to first string to select in the column (inclusive). - * @param end Index to last string to select in the column (exclusive). + * @param strings Strings instance for this operation + * @param start Index to first string to select in the column (inclusive) + * @param end Index to last string to select in the column (exclusive) * Default -1 indicates the last element. - * @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. + * @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 of size (end-start)/step. */ std::unique_ptr copy_slice( @@ -69,11 +69,11 @@ std::unique_ptr copy_slice( * * The caller should set the validity mask in the output column. * - * @param input Strings instance for this operation. - * @param offset The offset by which to shift the input. - * @param fill_value Fill value for indeterminable outputs. - * @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. + * @param input Strings instance for this operation + * @param offset The offset by which to shift the input + * @param fill_value Fill value for indeterminable outputs + * @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 shift(strings_column_view const& input, diff --git a/cpp/include/cudf/strings/detail/fill.hpp b/cpp/include/cudf/strings/detail/fill.hpp index 040175af9e5..3b2c174b276 100644 --- a/cpp/include/cudf/strings/detail/fill.hpp +++ b/cpp/include/cudf/strings/detail/fill.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2020, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,12 +33,12 @@ namespace detail { * * @throw cudf::logic_error if [begin,end) is outside the range of the input column. * - * @param strings Strings column to fill. - * @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 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. + * @param strings Strings column to fill + * @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 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 d46ab3a91a1..e122d70287a 100644 --- a/cpp/include/cudf/strings/detail/gather.cuh +++ b/cpp/include/cudf/strings/detail/gather.cuh @@ -68,11 +68,11 @@ __forceinline__ __device__ uint4 load_uint4(const char* ptr) * @tparam StringIterator Iterator should produce `string_view` objects. * @tparam MapIterator Iterator for retrieving integer indices of the `StringIterator`. * - * @param strings_begin Start of the iterator to retrieve `string_view` instances. - * @param out_chars Output buffer for gathered characters. - * @param out_offsets The offset values associated with the output buffer. - * @param string_indices Start of index iterator. - * @param total_out_strings Number of output strings to be gathered. + * @param strings_begin Start of the iterator to retrieve `string_view` instances + * @param out_chars Output buffer for gathered characters + * @param out_offsets The offset values associated with the output buffer + * @param string_indices Start of index iterator + * @param total_out_strings Number of output strings to be gathered */ template __global__ void gather_chars_fn_string_parallel(StringIterator strings_begin, @@ -153,11 +153,11 @@ __global__ void gather_chars_fn_string_parallel(StringIterator strings_begin, * @tparam StringIterator Iterator should produce `string_view` objects. * @tparam MapIterator Iterator for retrieving integer indices of the `StringIterator`. * - * @param strings_begin Start of the iterator to retrieve `string_view` instances. - * @param out_chars Output buffer for gathered characters. - * @param out_offsets The offset values associated with the output buffer. - * @param string_indices Start of index iterator. - * @param total_out_strings Number of output strings to be gathered. + * @param strings_begin Start of the iterator to retrieve `string_view` instances + * @param out_chars Output buffer for gathered characters + * @param out_offsets The offset values associated with the output buffer + * @param string_indices Start of index iterator + * @param total_out_strings Number of output strings to be gathered */ template __global__ void gather_chars_fn_char_parallel(StringIterator strings_begin, @@ -212,13 +212,13 @@ __global__ void gather_chars_fn_char_parallel(StringIterator strings_begin, * @tparam StringIterator Iterator should produce `string_view` objects. * @tparam MapIterator Iterator for retrieving integer indices of the `StringIterator`. * - * @param strings_begin Start of the iterator to retrieve `string_view` instances. - * @param map_begin Start of index iterator. - * @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 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. + * @param strings_begin Start of the iterator to retrieve `string_view` instances + * @param map_begin Start of index iterator + * @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 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 @@ -279,11 +279,11 @@ std::unique_ptr gather_chars(StringIterator strings_begin, * @tparam NullifyOutOfBounds If true, indices outside the column's range are nullified. * @tparam MapIterator Iterator for retrieving integer indices of the column. * - * @param strings Strings instance for this operation. - * @param begin Start of index iterator. - * @param end End of index iterator. - * @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. + * @param strings Strings instance for this operation + * @param begin Start of index iterator + * @param end End of index iterator + * @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 @@ -362,12 +362,12 @@ std::unique_ptr gather( * * @tparam MapIterator Iterator for retrieving integer indices of the column. * - * @param strings Strings instance for this operation. - * @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 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. + * @param strings Strings instance for this operation + * @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 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 207c9e9cd9f..68a016dd63a 100644 --- a/cpp/include/cudf/strings/detail/merge.cuh +++ b/cpp/include/cudf/strings/detail/merge.cuh @@ -41,11 +41,11 @@ namespace detail { * * @tparam row_order_iterator This must be an iterator for type thrust::tuple. * - * @param lhs First column. - * @param rhs Second column. - * @param row_order Indexes for each column. - * @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. + * @param lhs First column + * @param rhs Second column + * @param row_order Indexes for each column + * @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/replace.hpp b/cpp/include/cudf/strings/detail/replace.hpp index 820168ce3de..0243e99915c 100644 --- a/cpp/include/cudf/strings/detail/replace.hpp +++ b/cpp/include/cudf/strings/detail/replace.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2021, NVIDIA CORPORATION. + * Copyright (c) 2020-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,7 +39,7 @@ enum class replace_algorithm { * string_scalar const&, int32_t, rmm::mr::device_memory_resource*) * * @tparam alg Replacement algorithm to use - * @param[in] stream CUDA stream used for device memory operations and kernel launches. + * @param[in] stream CUDA stream used for device memory operations and kernel launches */ template std::unique_ptr replace( @@ -54,7 +54,7 @@ std::unique_ptr replace( * @copydoc cudf::strings::replace_slice(strings_column_view const&, string_scalar const&, * size_type. size_type, rmm::mr::device_memory_resource*) * - * @param[in] stream CUDA stream used for device memory operations and kernel launches. + * @param[in] stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr replace_slice( strings_column_view const& strings, @@ -68,7 +68,7 @@ std::unique_ptr replace_slice( * @copydoc cudf::strings::replace(strings_column_view const&, strings_column_view const&, * strings_column_view const&, rmm::mr::device_memory_resource*) * - * @param[in] stream CUDA stream used for device memory operations and kernel launches. + * @param[in] stream CUDA stream used for device memory operations and kernel launches */ std::unique_ptr replace( strings_column_view const& strings, @@ -89,10 +89,10 @@ std::unique_ptr replace( * r is now ["hello", "**", "goodbye"] * @endcode * - * @param strings Strings column for this operation. - * @param repl Replacement string for null entries. Default is empty string. - * @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. + * @param strings Strings column for this operation + * @param repl Replacement string for null entries. Default is empty string + * @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 replace_nulls( diff --git a/cpp/include/cudf/strings/detail/scatter.cuh b/cpp/include/cudf/strings/detail/scatter.cuh index cfede60c771..cbaaec0c1b6 100644 --- a/cpp/include/cudf/strings/detail/scatter.cuh +++ b/cpp/include/cudf/strings/detail/scatter.cuh @@ -45,11 +45,11 @@ namespace detail { * @tparam SourceIterator must produce string_view objects * @tparam MapIterator must produce index values within the target column. * - * @param source The iterator of source strings to scatter into the output column. - * @param scatter_map Iterator of indices into the output column. + * @param source The iterator of source strings to scatter into the output column + * @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 stream CUDA stream used for device memory operations and kernel launches. + * @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. */ diff --git a/cpp/include/cudf/strings/detail/utf8.hpp b/cpp/include/cudf/strings/detail/utf8.hpp index 1b88a9dd8fd..520ad3bdb3f 100644 --- a/cpp/include/cudf/strings/detail/utf8.hpp +++ b/cpp/include/cudf/strings/detail/utf8.hpp @@ -61,7 +61,7 @@ constexpr size_type bytes_in_char_utf8(char_utf8 character) * single character. For example, for the two-byte 0xC3A8 single character, * the first byte would return 2 and the second byte would return 0. * - * @param byte Byte from an encoded character. + * @param byte Byte from an encoded character * @return Number of bytes. */ constexpr size_type bytes_in_utf8_byte(uint8_t byte) @@ -75,8 +75,8 @@ constexpr size_type bytes_in_utf8_byte(uint8_t byte) /** * @brief Convert a char array into a char_utf8 value. * - * @param str String containing encoded char bytes. - * @param[out] character Single char_utf8 value. + * @param str String containing encoded char bytes + * @param[out] character Single char_utf8 value * @return The number of bytes in the character */ constexpr size_type to_char_utf8(const char* str, char_utf8& character) @@ -103,7 +103,7 @@ constexpr size_type to_char_utf8(const char* str, char_utf8& character) * @brief Place a char_utf8 value into a char array. * * @param character Single character - * @param[out] str Output array. + * @param[out] str Output array * @return The number of bytes in the character */ constexpr inline size_type from_char_utf8(char_utf8 character, char* str) diff --git a/cpp/include/cudf/strings/detail/utilities.cuh b/cpp/include/cudf/strings/detail/utilities.cuh index e6dba5147b5..7b3a3a0a55c 100644 --- a/cpp/include/cudf/strings/detail/utilities.cuh +++ b/cpp/include/cudf/strings/detail/utilities.cuh @@ -44,8 +44,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 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. + * @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 @@ -75,9 +75,9 @@ std::unique_ptr make_offsets_child_column( * @brief Copies input string data into a buffer and increments the pointer by the number of bytes * copied. * - * @param buffer Device buffer to copy to. - * @param input Data to copy from. - * @param bytes Number of bytes to copy. + * @param buffer Device buffer to copy to + * @param input Data to copy from + * @param bytes Number of bytes to copy * @return Pointer to the end of the output buffer after the copy. */ __device__ inline char* copy_and_increment(char* buffer, const char* input, size_type bytes) @@ -90,8 +90,8 @@ __device__ inline char* copy_and_increment(char* buffer, const char* input, size * @brief Copies input string data into a buffer and increments the pointer by the number of bytes * copied. * - * @param buffer Device buffer to copy to. - * @param d_string String to copy. + * @param buffer Device buffer to copy to + * @param d_string String to copy * @return Pointer to the end of the output buffer after the copy. */ __device__ inline char* copy_string(char* buffer, const string_view& d_string) @@ -107,13 +107,13 @@ __device__ inline char* copy_string(char* buffer, const string_view& d_string) * It must also have members d_offsets and d_chars which are set to * memory containing the offsets and chars columns during write. * - * @param size_and_exec_fn This is called twice. Once for the output size of each string. + * @param size_and_exec_fn This is called twice. Once for the output size of each string * After that, the d_offsets and d_chars are set and this is called again to fill in the * chars memory. - * @param exec_size Number of rows for executing the `size_and_exec_fn` function. - * @param strings_count Number of strings. - * @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. + * @param exec_size Number of rows for executing the `size_and_exec_fn` function + * @param strings_count Number of strings + * @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 @@ -167,12 +167,12 @@ auto make_strings_children( * It must also have members d_offsets and d_chars which are set to * memory containing the offsets and chars columns during write. * - * @param size_and_exec_fn This is called twice. Once for the output size of each string. + * @param size_and_exec_fn This is called twice. Once for the output size of each string * 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 stream CUDA stream used for device memory operations and kernel launches. - * @param mr Device memory resource used to allocate the returned columns' device memory. + * @param strings_count Number of strings + * @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/cudf/strings/detail/utilities.hpp b/cpp/include/cudf/strings/detail/utilities.hpp index c4f9e547148..faa3ccd7a45 100644 --- a/cpp/include/cudf/strings/detail/utilities.hpp +++ b/cpp/include/cudf/strings/detail/utilities.hpp @@ -30,9 +30,9 @@ namespace detail { * * This will return the properly sized column to be filled in by the caller. * - * @param bytes Number of bytes for the chars column. - * @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. + * @param bytes Number of bytes for the chars column + * @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 The chars child column for a strings column. */ std::unique_ptr create_chars_child_column( @@ -43,9 +43,9 @@ std::unique_ptr create_chars_child_column( /** * @brief Creates a string_view vector from a strings column. * - * @param strings Strings column instance. - * @param stream CUDA stream used for device memory operations and kernel launches. - * @param mr Device memory resource used to allocate the returned vector's device memory. + * @param strings Strings column instance + * @param stream CUDA stream used for device memory operations and kernel launches + * @param mr Device memory resource used to allocate the returned vector's device memory * @return Device vector of string_views */ rmm::device_uvector create_string_vector_from_column( diff --git a/cpp/include/cudf/strings/extract.hpp b/cpp/include/cudf/strings/extract.hpp index 680d0f5b7bc..13653ccf795 100644 --- a/cpp/include/cudf/strings/extract.hpp +++ b/cpp/include/cudf/strings/extract.hpp @@ -47,10 +47,10 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param pattern The regular expression pattern with group indicators. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned table's device memory. + * @param strings Strings instance for this operation + * @param pattern The regular expression pattern with group indicators + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned table's device memory * @return Columns of strings extracted from the input column. */ std::unique_ptr extract( @@ -82,10 +82,10 @@ std::unique_ptr
extract( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param pattern The regular expression pattern with group indicators. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate any returned device memory. + * @param strings Strings instance for this operation + * @param pattern The regular expression pattern with group indicators + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate any returned device memory * @return Lists column containing strings extracted from the input column. */ std::unique_ptr extract_all_record( diff --git a/cpp/include/cudf/strings/find.hpp b/cpp/include/cudf/strings/find.hpp index fee1ea2dae4..4f57520b789 100644 --- a/cpp/include/cudf/strings/find.hpp +++ b/cpp/include/cudf/strings/find.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -41,12 +41,12 @@ namespace strings { * * @throw cudf::logic_error if start position is greater than stop position. * - * @param strings Strings instance for this operation. - * @param target UTF-8 encoded string to search for in each string. - * @param start First character position to include in the search. - * @param stop Last position (exclusive) to include in the search. + * @param strings Strings instance for this operation + * @param target UTF-8 encoded string to search for in each string + * @param start First character position to include in the search + * @param stop Last position (exclusive) to include in the search * Default of -1 will search to the end of the string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New integer column with character position values. */ std::unique_ptr find( @@ -70,12 +70,12 @@ std::unique_ptr find( * * @throw cudf::logic_error if start position is greater than stop position. * - * @param strings Strings instance for this operation. - * @param target UTF-8 encoded string to search for in each string. - * @param start First position to include in the search. - * @param stop Last position (exclusive) to include in the search. + * @param strings Strings instance for this operation + * @param target UTF-8 encoded string to search for in each string + * @param start First position to include in the search + * @param stop Last position (exclusive) to include in the search * Default of -1 will search starting at the end of the string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New integer column with character position values. */ std::unique_ptr rfind( @@ -94,9 +94,9 @@ std::unique_ptr rfind( * * Any null string entries return corresponding null entries in the output columns. * - * @param strings Strings instance for this operation. - * @param target UTF-8 encoded string to search for in each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param target UTF-8 encoded string to search for in each string + * @param mr Device memory resource used to allocate the returned column's device memory * @return New type_id::BOOL8 column. */ std::unique_ptr contains( @@ -117,9 +117,9 @@ std::unique_ptr contains( * * @throw cudf::logic_error if `strings.size() != targets.size()`. * - * @param strings Strings instance for this operation. - * @param targets Strings column of targets to check row-wise in `strings`. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param targets Strings column of targets to check row-wise in `strings` + * @param mr Device memory resource used to allocate the returned column's device memory * @return New type_id::BOOL8 column. */ std::unique_ptr contains( @@ -137,9 +137,9 @@ std::unique_ptr contains( * * Any null string entries return corresponding null entries in the output columns. * - * @param strings Strings instance for this operation. - * @param target UTF-8 encoded string to search for in each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param target UTF-8 encoded string to search for in each string + * @param mr Device memory resource used to allocate the returned column's device memory * @return New type_id::BOOL8 column. */ std::unique_ptr starts_with( @@ -161,9 +161,9 @@ std::unique_ptr starts_with( * * @throw cudf::logic_error if `strings.size() != targets.size()`. * - * @param strings Strings instance for this operation. - * @param targets Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param targets Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New type_id::BOOL8 column. */ std::unique_ptr starts_with( @@ -181,9 +181,9 @@ std::unique_ptr starts_with( * * Any null string entries return corresponding null entries in the output columns. * - * @param strings Strings instance for this operation. - * @param target UTF-8 encoded string to search for in each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param target UTF-8 encoded string to search for in each string + * @param mr Device memory resource used to allocate the returned column's device memory * @return New type_id::BOOL8 column. */ std::unique_ptr ends_with( @@ -205,9 +205,9 @@ std::unique_ptr ends_with( * * @throw cudf::logic_error if `strings.size() != targets.size()`. * - * @param strings Strings instance for this operation. - * @param targets Strings instance for this operation. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param targets Strings instance for this operation + * @param mr Device memory resource used to allocate the returned column's device memory * @return New type_id::BOOL8 column. */ std::unique_ptr ends_with( diff --git a/cpp/include/cudf/strings/find_multiple.hpp b/cpp/include/cudf/strings/find_multiple.hpp index 0964e713592..b92ebaa1c8d 100644 --- a/cpp/include/cudf/strings/find_multiple.hpp +++ b/cpp/include/cudf/strings/find_multiple.hpp @@ -46,9 +46,9 @@ namespace strings { * * @throw cudf::logic_error if `targets` is empty or contains nulls * - * @param input Strings instance for this operation. - * @param targets Strings to search for in each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Strings instance for this operation + * @param targets Strings to search for in each string + * @param mr Device memory resource used to allocate the returned column's device memory * @return Lists column with character position values. */ std::unique_ptr find_multiple( diff --git a/cpp/include/cudf/strings/findall.hpp b/cpp/include/cudf/strings/findall.hpp index 25c6d523250..bcee5b564c9 100644 --- a/cpp/include/cudf/strings/findall.hpp +++ b/cpp/include/cudf/strings/findall.hpp @@ -48,10 +48,10 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param input Strings instance for this operation. - * @param pattern Regex pattern to match within each string. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned table's device memory. + * @param input Strings instance for this operation + * @param pattern Regex pattern to match within each string + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned table's device memory * @return New table of strings columns. */ std::unique_ptr
findall( @@ -82,10 +82,10 @@ std::unique_ptr
findall( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param input Strings instance for this operation. - * @param pattern Regex pattern to match within each string. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param input Strings instance for this operation + * @param pattern Regex pattern to match within each string + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned column's device memory * @return New lists column of strings. */ std::unique_ptr findall_record( diff --git a/cpp/include/cudf/strings/json.hpp b/cpp/include/cudf/strings/json.hpp index 2b66bcb807e..8843b5df157 100644 --- a/cpp/include/cudf/strings/json.hpp +++ b/cpp/include/cudf/strings/json.hpp @@ -87,7 +87,7 @@ class get_json_object_options { /** * @brief Set whether single-quotes for strings are allowed. * - * @param _allow_single_quotes bool indicating desired behavior. + * @param _allow_single_quotes bool indicating desired behavior */ void set_allow_single_quotes(bool _allow_single_quotes) { @@ -97,7 +97,7 @@ class get_json_object_options { /** * @brief Set whether individually returned string values have their quotes stripped. * - * @param _strip_quotes_from_single_strings bool indicating desired behavior. + * @param _strip_quotes_from_single_strings bool indicating desired behavior */ void set_strip_quotes_from_single_strings(bool _strip_quotes_from_single_strings) { @@ -114,10 +114,10 @@ class get_json_object_options { * https://tools.ietf.org/id/draft-goessner-dispatch-jsonpath-00.html * Implements only the operators: $ . [] * * - * @param col The input strings column. Each row must contain a valid json string + * @param col The input strings column Each row must contain a valid json string * @param json_path The JSONPath string to be applied to each row * @param options Options for controlling the behavior of the function - * @param mr Resource for allocating device memory. + * @param mr Resource for allocating device memory * @return New strings column containing the retrieved json object strings */ std::unique_ptr get_json_object( diff --git a/cpp/include/cudf/strings/padding.hpp b/cpp/include/cudf/strings/padding.hpp index 754e828fae0..95fce5a2c9e 100644 --- a/cpp/include/cudf/strings/padding.hpp +++ b/cpp/include/cudf/strings/padding.hpp @@ -52,13 +52,13 @@ enum class pad_side { * r is now ['aa ','bbb ','cccc','ddddd'] * @endcode * - * @param strings Strings instance for this operation. - * @param width The minimum number of characters for each string. - * @param side Where to place the padding characters. + * @param strings Strings instance for this operation + * @param width The minimum number of characters for each string + * @param side Where to place the padding characters * Default is pad right (left justify). - * @param fill_char Single UTF-8 character to use for padding. + * @param fill_char Single UTF-8 character to use for padding * Default is the space character. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with padded strings. */ std::unique_ptr pad( @@ -85,9 +85,9 @@ std::unique_ptr pad( * r is now ['001234','0-9876','0+0.34','-342567'] * @endcode * - * @param strings Strings instance for this operation. - * @param width The minimum number of characters for each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param width The minimum number of characters for each string + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column of strings. */ std::unique_ptr zfill( diff --git a/cpp/include/cudf/strings/repeat_strings.hpp b/cpp/include/cudf/strings/repeat_strings.hpp index f6bf12af967..f7366efd512 100644 --- a/cpp/include/cudf/strings/repeat_strings.hpp +++ b/cpp/include/cudf/strings/repeat_strings.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021, NVIDIA CORPORATION. + * Copyright (c) 2021-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,9 +51,9 @@ namespace strings { * can be stored by the index type * (i.e., @code input.size() * repeat_times > numeric_limits::max() @endcode). * - * @param input The scalar containing the string to repeat. - * @param repeat_times The number of times the input string is repeated. - * @param mr Device memory resource used to allocate the returned string scalar. + * @param input The scalar containing the string to repeat + * @param repeat_times The number of times the input string is repeated + * @param mr Device memory resource used to allocate the returned string scalar * @return New string scalar in which the input string is repeated. */ std::unique_ptr repeat_string( @@ -83,9 +83,9 @@ std::unique_ptr repeat_string( * out is ['aaaaaa', null, '', 'bbcbbcbbc'] * @endcode * - * @param input The column containing strings to repeat. - * @param repeat_times The number of times each input string is repeated. - * @param mr Device memory resource used to allocate the returned strings column. + * @param input The column containing strings to repeat + * @param repeat_times The number of times each input string is repeated + * @param mr Device memory resource used to allocate the returned strings column * @return New column containing the repeated strings. */ std::unique_ptr repeat_strings( @@ -121,12 +121,12 @@ std::unique_ptr repeat_strings( * @throw cudf::logic_error if the input `repeat_times` column has data type other than integer. * @throw cudf::logic_error if the input columns have different sizes. * - * @param input The column containing strings to repeat. + * @param input The column containing strings to repeat * @param repeat_times The column containing numbers of times that the corresponding input strings * are repeated. * @param output_strings_sizes The optional column containing pre-computed sizes of the output * strings. - * @param mr Device memory resource used to allocate the returned strings column. + * @param mr Device memory resource used to allocate the returned strings column * @return New column containing the repeated strings. */ std::unique_ptr repeat_strings( @@ -154,10 +154,10 @@ std::unique_ptr repeat_strings( * @throw cudf::logic_error if the input `repeat_times` column has data type other than integer. * @throw cudf::logic_error if the input columns have different sizes. * - * @param input The column containing strings to repeat. + * @param input The column containing strings to repeat * @param repeat_times The column containing numbers of times that the corresponding input strings * are repeated. - * @param mr Device memory resource used to allocate the returned strings column. + * @param mr Device memory resource used to allocate the returned strings column * @return A pair with the first item is an int32_t column containing sizes of the output strings, * and the second item is an int64_t number containing the total sizes (in bytes) of the * output strings column. diff --git a/cpp/include/cudf/strings/replace.hpp b/cpp/include/cudf/strings/replace.hpp index 40eb796eba7..4c0cc0ef077 100644 --- a/cpp/include/cudf/strings/replace.hpp +++ b/cpp/include/cudf/strings/replace.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -52,12 +52,12 @@ namespace strings { * * @throw cudf::logic_error if target is an empty string. * - * @param strings Strings column for this operation. - * @param target String to search for within each string. - * @param repl Replacement string if target is found. - * @param maxrepl Maximum times to replace if target appears multiple times in the input string. + * @param strings Strings column for this operation + * @param target String to search for within each string + * @param repl Replacement string if target is found + * @param maxrepl Maximum times to replace if target appears multiple times in the input string * Default of -1 specifies replace all occurrences of target in each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr replace( @@ -90,14 +90,14 @@ std::unique_ptr replace( * * @throw cudf::logic_error if start is greater than stop. * - * @param strings Strings column for this operation. - * @param repl Replacement string for specified positions found. + * @param strings Strings column for this operation + * @param repl Replacement string for specified positions found * Default is empty string. - * @param start Start position where repl will be added. + * @param start Start position where repl will be added * Default is 0, first character position. - * @param stop End position (exclusive) to use for replacement. + * @param stop End position (exclusive) to use for replacement * Default of -1 specifies the end of each string. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr replace_slice( @@ -139,10 +139,10 @@ std::unique_ptr replace_slice( * if repls is a single string. * @throw cudf::logic_error if targets or repls contain null entries. * - * @param strings Strings column for this operation. - * @param targets Strings to search for in each string. - * @param repls Corresponding replacement strings for target strings. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings column for this operation + * @param targets Strings to search for in each string + * @param repls Corresponding replacement strings for target strings + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr replace( diff --git a/cpp/include/cudf/strings/replace_re.hpp b/cpp/include/cudf/strings/replace_re.hpp index 36c287009d0..ae75367cbf5 100644 --- a/cpp/include/cudf/strings/replace_re.hpp +++ b/cpp/include/cudf/strings/replace_re.hpp @@ -38,14 +38,14 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param pattern The regular expression pattern to search within each string. - * @param replacement The string used to replace the matched sequence in each string. + * @param strings Strings instance for this operation + * @param pattern The regular expression pattern to search within each string + * @param replacement The string used to replace the matched sequence in each string * Default is an empty string. * @param max_replace_count The maximum number of times to replace the matched pattern * within each string. Default replaces every substring that is matched. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr replace_re( @@ -64,11 +64,11 @@ std::unique_ptr replace_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation. - * @param patterns The regular expression patterns to search within each string. - * @param replacements The strings used for replacement. - * @param flags Regex flags for interpreting special characters in the patterns. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param patterns The regular expression patterns to search within each string + * @param replacements The strings used for replacement + * @param flags Regex flags for interpreting special characters in the patterns + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr replace_re( @@ -89,11 +89,11 @@ std::unique_ptr replace_re( * @throw cudf::logic_error if capture index values in `replacement` are not in range 0-99, and also * if the index exceeds the group count specified in the pattern * - * @param strings Strings instance for this operation. - * @param pattern The regular expression patterns to search within each string. - * @param replacement The replacement template for creating the output string. - * @param flags Regex flags for interpreting special characters in the pattern. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param pattern The regular expression patterns to search within each string + * @param replacement The replacement template for creating the output string + * @param flags Regex flags for interpreting special characters in the pattern + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr replace_with_backrefs( diff --git a/cpp/include/cudf/strings/split/partition.hpp b/cpp/include/cudf/strings/split/partition.hpp index 305726a1f21..93308e56240 100644 --- a/cpp/include/cudf/strings/split/partition.hpp +++ b/cpp/include/cudf/strings/split/partition.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -49,10 +49,10 @@ namespace strings { * r[2] is ["cd","g_h"] * @endcode * - * @param strings Strings instance for this operation. - * @param delimiter UTF-8 encoded string indicating where to split each string. + * @param strings Strings instance for this operation + * @param delimiter UTF-8 encoded string indicating where to split each string * Default of empty string indicates split on whitespace. - * @param mr Device memory resource used to allocate the returned table's device memory. + * @param mr Device memory resource used to allocate the returned table's device memory * @return New table of strings columns. */ std::unique_ptr
partition( @@ -81,10 +81,10 @@ std::unique_ptr
partition( * r[2] is ["cd","h"] * @endcode * - * @param strings Strings instance for this operation. - * @param delimiter UTF-8 encoded string indicating where to split each string. + * @param strings Strings instance for this operation + * @param delimiter UTF-8 encoded string indicating where to split each string * Default of empty string indicates split on whitespace. - * @param mr Device memory resource used to allocate the returned table's device memory. + * @param mr Device memory resource used to allocate the returned table's device memory * @return New strings columns. */ std::unique_ptr
rpartition( diff --git a/cpp/include/cudf/strings/split/split.hpp b/cpp/include/cudf/strings/split/split.hpp index 4978bad3bb3..35efb016d05 100644 --- a/cpp/include/cudf/strings/split/split.hpp +++ b/cpp/include/cudf/strings/split/split.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2020, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -41,12 +41,12 @@ namespace strings { * * Any null string entries return corresponding null output columns. * - * @param strings_column Strings instance for this operation. - * @param delimiter UTF-8 encoded string indicating the split points in each string. + * @param strings_column Strings instance for this operation + * @param delimiter UTF-8 encoded string indicating the split points in each string * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform. + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned table's device memory. + * @param mr Device memory resource used to allocate the returned table's device memory * @return New table of strings columns. */ std::unique_ptr
split( @@ -69,12 +69,12 @@ std::unique_ptr
split( * * Any null string entries return corresponding null output columns. * - * @param strings_column Strings instance for this operation. - * @param delimiter UTF-8 encoded string indicating the split points in each string. + * @param strings_column Strings instance for this operation + * @param delimiter UTF-8 encoded string indicating the split points in each string * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform. + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned table's device memory. + * @param mr Device memory resource used to allocate the returned table's device memory * @return New strings columns. */ std::unique_ptr
rsplit( @@ -139,12 +139,12 @@ std::unique_ptr
rsplit( * * @throw cudf:logic_error if `delimiter` is invalid. * - * @param strings A column of string elements to be split. - * @param delimiter The string to identify split points in each string. + * @param strings A column of string elements to be split + * @param delimiter The string to identify split points in each string * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform. + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory. + * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings * Each vector of the lists column holds splits from a single row * element of the input column. @@ -216,12 +216,12 @@ std::unique_ptr split_record( * * @throw cudf:logic_error if `delimiter` is invalid. * - * @param strings A column of string elements to be split. - * @param delimiter The string to identify split points in each string. + * @param strings A column of string elements to be split + * @param delimiter The string to identify split points in each string * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform. + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory. + * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings * Each vector of the lists column holds splits from a single row * element of the input column. diff --git a/cpp/include/cudf/strings/split/split_re.hpp b/cpp/include/cudf/strings/split/split_re.hpp index 57246bd91d2..1023e6f0e32 100644 --- a/cpp/include/cudf/strings/split/split_re.hpp +++ b/cpp/include/cudf/strings/split/split_re.hpp @@ -62,11 +62,11 @@ namespace strings { * * @throw cudf::logic_error if `pattern` is empty. * - * @param input A column of string elements to be split. - * @param pattern The regex pattern for delimiting characters within each string. - * @param maxsplit Maximum number of splits to perform. + * @param input A column of string elements to be split + * @param pattern The regex pattern for delimiting characters within each string + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory. + * @param mr Device memory resource used to allocate the returned result's device memory * @return A table of columns of strings. */ std::unique_ptr
split_re( @@ -112,11 +112,11 @@ std::unique_ptr
split_re( * * @throw cudf::logic_error if `pattern` is empty. * - * @param input A column of string elements to be split. - * @param pattern The regex pattern for delimiting characters within each string. - * @param maxsplit Maximum number of splits to perform. + * @param input A column of string elements to be split + * @param pattern The regex pattern for delimiting characters within each string + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory. + * @param mr Device memory resource used to allocate the returned result's device memory * @return A table of columns of strings. */ std::unique_ptr
rsplit_re( @@ -164,11 +164,11 @@ std::unique_ptr
rsplit_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param input A column of string elements to be split. - * @param pattern The regex pattern for delimiting characters within each string. - * @param maxsplit Maximum number of splits to perform. + * @param input A column of string elements to be split + * @param pattern The regex pattern for delimiting characters within each string + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory. + * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings. */ std::unique_ptr split_record_re( @@ -218,11 +218,11 @@ std::unique_ptr split_record_re( * * @throw cudf::logic_error if `pattern` is empty. * - * @param input A column of string elements to be split. - * @param pattern The regex pattern for delimiting characters within each string. - * @param maxsplit Maximum number of splits to perform. + * @param input A column of string elements to be split + * @param pattern The regex pattern for delimiting characters within each string + * @param maxsplit Maximum number of splits to perform * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory. + * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings. */ std::unique_ptr rsplit_record_re( diff --git a/cpp/include/cudf/strings/string.cuh b/cpp/include/cudf/strings/string.cuh index d20080cc0e5..24c3bb9fb02 100644 --- a/cpp/include/cudf/strings/string.cuh +++ b/cpp/include/cudf/strings/string.cuh @@ -40,7 +40,7 @@ namespace strings { * No bounds checking is performed to verify if the integer will fit * within a specific integer type. * - * @param d_str String to check. + * @param d_str String to check * @return true if string has valid integer characters */ inline __device__ bool is_integer(string_view const& d_str) @@ -107,7 +107,7 @@ inline __device__ bool is_inf_str(string_view const& d_str) * The following strings are also allowed and will return true: * "NaN", "NAN", "Inf", "INF", "INFINITY" * - * @param d_str String to check. + * @param d_str String to check * @return true if string has valid float characters */ inline __device__ bool is_float(string_view const& d_str) diff --git a/cpp/include/cudf/strings/string_view.cuh b/cpp/include/cudf/strings/string_view.cuh index 57d082cf11c..21f4ab96110 100644 --- a/cpp/include/cudf/strings/string_view.cuh +++ b/cpp/include/cudf/strings/string_view.cuh @@ -40,8 +40,8 @@ namespace detail { /** * @brief Return the number of UTF-8 characters in this provided char array. * - * @param str String with encoded char bytes. - * @param bytes Number of bytes in str. + * @param str String with encoded char bytes + * @param bytes Number of bytes in str * @return The number of characters in the array. */ __device__ inline size_type characters_in_string(const char* str, size_type bytes) diff --git a/cpp/include/cudf/strings/string_view.hpp b/cpp/include/cudf/strings/string_view.hpp index fbe2253bf25..0ccb62bd375 100644 --- a/cpp/include/cudf/strings/string_view.hpp +++ b/cpp/include/cudf/strings/string_view.hpp @@ -148,7 +148,7 @@ class string_view { * @brief Comparing target string with this string. Each character is compared * as a UTF-8 code-point value. * - * @param str Target string to compare with this string. + * @param str Target string to compare with this string * @return 0 If they compare equal. * <0 Either the value of the first character of this string that does * not match is lower in the arg string, or all compared characters @@ -162,8 +162,8 @@ class string_view { * @brief Comparing target string with this string. Each character is compared * as a UTF-8 code-point value. * - * @param str Target string to compare with this string. - * @param bytes Number of bytes in str. + * @param str Target string to compare with this string + * @param bytes Number of bytes in str * @return 0 If they compare equal. * <0 Either the value of the first character of this string that does * not match is lower in the arg string, or all compared characters @@ -177,42 +177,42 @@ class string_view { /** * @brief Returns true if rhs matches this string exactly. * - * @param rhs Target string to compare with this string. + * @param rhs Target string to compare with this string * @return true if rhs matches this string exactly */ __device__ inline bool operator==(const string_view& rhs) const; /** * @brief Returns true if rhs does not match this string. * - * @param rhs Target string to compare with this string. + * @param rhs Target string to compare with this string * @return true if rhs does not match this string */ __device__ inline bool operator!=(const string_view& rhs) const; /** * @brief Returns true if this string is ordered before rhs. * - * @param rhs Target string to compare with this string. + * @param rhs Target string to compare with this string * @return true if this string is ordered before rhs */ __device__ inline bool operator<(const string_view& rhs) const; /** * @brief Returns true if rhs is ordered before this string. * - * @param rhs Target string to compare with this string. + * @param rhs Target string to compare with this string * @return true if rhs is ordered before this string */ __device__ inline bool operator>(const string_view& rhs) const; /** * @brief Returns true if this string matches or is ordered before rhs. * - * @param rhs Target string to compare with this string. + * @param rhs Target string to compare with this string * @return true if this string matches or is ordered before rhs */ __device__ inline bool operator<=(const string_view& rhs) const; /** * @brief Returns true if rhs matches or is ordered before this string. * - * @param rhs Target string to compare with this string. + * @param rhs Target string to compare with this string * @return true if rhs matches or is ordered before this string */ __device__ inline bool operator>=(const string_view& rhs) const; @@ -221,9 +221,9 @@ class string_view { * @brief Returns the character position of the first occurrence where the * argument str is found in this string within the character range [pos,pos+n). * - * @param str Target string to search within this string. - * @param pos Character position to start search within this string. - * @param count Number of characters from pos to include in the search. + * @param str Target string to search within this string + * @param pos Character position to start search within this string + * @param count Number of characters from pos to include in the search * Specify -1 to indicate to the end of the string. * @return -1 if str is not found in this string. */ @@ -234,10 +234,10 @@ class string_view { * @brief Returns the character position of the first occurrence where the * array str is found in this string within the character range [pos,pos+n). * - * @param str Target array to search within this string. - * @param bytes Number of bytes in str. - * @param pos Character position to start search within this string. - * @param count Number of characters from pos to include in the search. + * @param str Target array to search within this string + * @param bytes Number of bytes in str + * @param pos Character position to start search within this string + * @param count Number of characters from pos to include in the search * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -249,9 +249,9 @@ class string_view { * @brief Returns the character position of the first occurrence where * character is found in this string within the character range [pos,pos+n). * - * @param character Single encoded character. - * @param pos Character position to start search within this string. - * @param count Number of characters from pos to include in the search. + * @param character Single encoded character + * @param pos Character position to start search within this string + * @param count Number of characters from pos to include in the search * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -262,9 +262,9 @@ class string_view { * @brief Returns the character position of the last occurrence where the * argument str is found in this string within the character range [pos,pos+n). * - * @param str Target string to search within this string. - * @param pos Character position to start search within this string. - * @param count Number of characters from pos to include in the search. + * @param str Target string to search within this string + * @param pos Character position to start search within this string + * @param count Number of characters from pos to include in the search * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -275,10 +275,10 @@ class string_view { * @brief Returns the character position of the last occurrence where the * array str is found in this string within the character range [pos,pos+n). * - * @param str Target string to search with this string. - * @param bytes Number of bytes in str. - * @param pos Character position to start search within this string. - * @param count Number of characters from pos to include in the search. + * @param str Target string to search with this string + * @param bytes Number of bytes in str + * @param pos Character position to start search within this string + * @param count Number of characters from pos to include in the search * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -290,9 +290,9 @@ class string_view { * @brief Returns the character position of the last occurrence where * character is found in this string within the character range [pos,pos+n). * - * @param character Single encoded character. - * @param pos Character position to start search within this string. - * @param count Number of characters from pos to include in the search. + * @param character Single encoded character + * @param pos Character position to start search within this string + * @param count Number of characters from pos to include in the search * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -304,8 +304,8 @@ class string_view { * @brief Return a sub-string of this string. The original string and device * memory must still be maintained for the lifetime of the returned instance. * - * @param start Character position to start the sub-string. - * @param length Number of characters from start to include in the sub-string. + * @param start Character position to start the sub-string + * @param length Number of characters from start to include in the sub-string * @return New instance pointing to a subset of the characters within this instance. */ __device__ [[nodiscard]] inline string_view substr(size_type start, size_type length) const; @@ -339,8 +339,8 @@ class string_view { /** * @brief Create instance from existing device char array. * - * @param data Device char array encoded in UTF8. - * @param bytes Number of bytes in data array. + * @param data Device char array encoded in UTF8 + * @param bytes Number of bytes in data array */ CUDF_HOST_DEVICE inline string_view(const char* data, size_type bytes) : _data(data), _bytes(bytes), _length(UNKNOWN_STRING_LENGTH) @@ -371,7 +371,7 @@ class string_view { /** * @brief Return the character position of the given byte offset. * - * @param bytepos Byte position from start of _data. + * @param bytepos Byte position from start of _data * @return The character position for the specified byte. */ __device__ [[nodiscard]] inline size_type character_offset(size_type bytepos) const; diff --git a/cpp/include/cudf/strings/strings_column_view.hpp b/cpp/include/cudf/strings/strings_column_view.hpp index e617dbde024..efc70bab704 100644 --- a/cpp/include/cudf/strings/strings_column_view.hpp +++ b/cpp/include/cudf/strings/strings_column_view.hpp @@ -36,9 +36,9 @@ namespace cudf { class strings_column_view : private column_view { public: /** - * @brief Construct a new strings column view object from a column view.s + * @brief Construct a new strings_column_view object from a column_view * - * @param strings_column The column view to wrap. + * @param strings_column The column_view to wrap */ strings_column_view(column_view strings_column); strings_column_view(strings_column_view&&) = default; ///< Move constructor diff --git a/cpp/include/cudf/strings/strip.hpp b/cpp/include/cudf/strings/strip.hpp index fe9cd41e780..13876dd7c5d 100644 --- a/cpp/include/cudf/strings/strip.hpp +++ b/cpp/include/cudf/strings/strip.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -58,12 +58,12 @@ enum class strip_type { * * @throw cudf::logic_error if `to_strip` is invalid. * - * @param strings Strings column for this operation. + * @param strings Strings column for this operation * @param stype Indicates characters are to be stripped from the beginning, end, or both of each * string. Default is both. - * @param to_strip UTF-8 encoded characters to strip from each string. + * @param to_strip UTF-8 encoded characters to strip from each string * Default is empty string which indicates strip whitespace characters. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. */ std::unique_ptr strip( diff --git a/cpp/include/cudf/strings/substring.hpp b/cpp/include/cudf/strings/substring.hpp index 645b0cead3f..dbd94e618cc 100644 --- a/cpp/include/cudf/strings/substring.hpp +++ b/cpp/include/cudf/strings/substring.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2020, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -48,11 +48,11 @@ namespace strings { * r2 is now ["lo","ob"] * @endcode * - * @param strings Strings column for this operation. - * @param start First character position to begin the substring. - * @param stop Last character position (exclusive) to end the substring. - * @param step Distance between input characters retrieved. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings column for this operation + * @param start First character position to begin the substring + * @param stop Last character position (exclusive) to end the substring + * @param step Distance between input characters retrieved + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with sorted elements of this instance. */ std::unique_ptr slice_strings( @@ -93,10 +93,10 @@ std::unique_ptr slice_strings( * @throw cudf::logic_error if starts and stops are not same integer type. * @throw cudf::logic_error if starts or stops contains nulls. * - * @param strings Strings column for this operation. - * @param starts First character positions to begin the substring. - * @param stops Last character (exclusive) positions to end the substring. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings column for this operation + * @param starts First character positions to begin the substring + * @param stops Last character (exclusive) positions to end the substring + * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with sorted elements of this instance. */ std::unique_ptr slice_strings( @@ -135,11 +135,11 @@ std::unique_ptr slice_strings( * r = ['nvidia.com', null, 'google.com', '', 'foo'] * @endcode * - * @param strings Strings instance for this operation. - * @param delimiter UTF-8 encoded string to search for in each string. - * @param count Number of times to search for delimiter in each string. If the value is positive, + * @param strings Strings instance for this operation + * @param delimiter UTF-8 encoded string to search for in each string + * @param count Number of times to search for delimiter in each string If the value is positive, * delimiter is searched from left to right; else, it is searched from right to left. - * @param mr Resource for allocating device memory. + * @param mr Resource for allocating device memory * @return New strings column containing the substrings. */ std::unique_ptr slice_strings( @@ -185,11 +185,11 @@ std::unique_ptr slice_strings( * @throw cudf::logic_error if the number of rows in @p strings and @p delimiter_strings do not * match. * - * @param strings Strings instance for this operation. - * @param delimiter_strings UTF-8 encoded string for each row. - * @param count Number of times to search for delimiter in each string. If the value is positive, + * @param strings Strings instance for this operation + * @param delimiter_strings UTF-8 encoded string for each row + * @param count Number of times to search for delimiter in each string If the value is positive, * delimiter is searched from left to right; else, it is searched from right to left. - * @param mr Resource for allocating device memory. + * @param mr Resource for allocating device memory * @return New strings column containing the substrings. */ std::unique_ptr slice_strings( diff --git a/cpp/include/cudf/strings/translate.hpp b/cpp/include/cudf/strings/translate.hpp index 0cbf6b22029..de23cc1d4c2 100644 --- a/cpp/include/cudf/strings/translate.hpp +++ b/cpp/include/cudf/strings/translate.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2021, NVIDIA CORPORATION. + * Copyright (c) 2019-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,9 +47,9 @@ namespace strings { * r is now ["AA", "", "cccc", "AcQ"] * @endcode * - * @param strings Strings instance for this operation. - * @param chars_table Table of UTF-8 character mappings. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param strings Strings instance for this operation + * @param chars_table Table of UTF-8 character mappings + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with padded strings. */ std::unique_ptr translate( @@ -87,12 +87,12 @@ enum class filter_type : bool { * * @throw cudf::logic_error if `replacement` is invalid * - * @param strings Strings instance for this operation. - * @param characters_to_filter Table of character ranges to filter on. + * @param strings Strings instance for this operation + * @param characters_to_filter Table of character ranges to filter on * @param keep_characters If true, the `characters_to_filter` are retained and all other characters * are removed. - * @param replacement Optional replacement string for each character removed. - * @param mr Device memory resource used to allocate the returned column's device memory. + * @param replacement Optional replacement string for each character removed + * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with filtered strings. */ std::unique_ptr filter_characters( diff --git a/cpp/include/cudf/strings/wrap.hpp b/cpp/include/cudf/strings/wrap.hpp index 0ca8e30b644..c36ed43292d 100644 --- a/cpp/include/cudf/strings/wrap.hpp +++ b/cpp/include/cudf/strings/wrap.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020, NVIDIA CORPORATION. + * Copyright (c) 2020-2022, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -55,8 +55,8 @@ namespace strings { * wrapped_string_tbl = ["the quick\nbrown fox\njumped over\nthe lazy\nbrown dog", "hello, world"] * ``` * - * @param[in] strings String column. - * @param[in] width Maximum character width of a line within each string. + * @param[in] strings String column + * @param[in] width Maximum character width of a line within each string * @param[in] mr Device memory resource used to allocate the returned column's device memory * @return Column of wrapped strings. */ From 8532709fb42348d9243e766ae8d861280c6094a1 Mon Sep 17 00:00:00 2001 From: Karthikeyan Natarajan Date: Wed, 25 May 2022 13:47:45 +0530 Subject: [PATCH 3/6] address review comments --- .../cudf/strings/convert/convert_datetime.hpp | 2 +- .../cudf/strings/convert/convert_durations.hpp | 2 +- .../cudf/strings/detail/convert/fixed_point.cuh | 2 +- cpp/include/cudf/strings/detail/copying.hpp | 2 +- cpp/include/cudf/strings/detail/utilities.cuh | 4 ++-- cpp/include/cudf/strings/find.hpp | 4 ++-- cpp/include/cudf/strings/padding.hpp | 4 ++-- cpp/include/cudf/strings/replace.hpp | 6 +++--- cpp/include/cudf/strings/replace_re.hpp | 2 +- cpp/include/cudf/strings/split/partition.hpp | 4 ++-- cpp/include/cudf/strings/split/split.hpp | 12 ++++++------ cpp/include/cudf/strings/split/split_re.hpp | 8 ++++---- cpp/include/cudf/strings/string_view.hpp | 12 ++++++------ cpp/include/cudf/strings/substring.hpp | 2 +- 14 files changed, 33 insertions(+), 33 deletions(-) diff --git a/cpp/include/cudf/strings/convert/convert_datetime.hpp b/cpp/include/cudf/strings/convert/convert_datetime.hpp index 6118639c12a..cb488c3773e 100644 --- a/cpp/include/cudf/strings/convert/convert_datetime.hpp +++ b/cpp/include/cudf/strings/convert/convert_datetime.hpp @@ -216,7 +216,7 @@ std::unique_ptr is_timestamp( * @throw cudf::logic_error if `names.size()` is an invalid size. Must be 0 or 40 strings. * * @param timestamps Timestamp values to convert - * @param format The string specifying output format + * @param format The string specifying output format; * Default format is "%Y-%m-%dT%H:%M:%SZ". * @param names The string names to use for weekdays ("%a", "%A") and months ("%b", "%B") * Default is an empty `strings_column_view`. diff --git a/cpp/include/cudf/strings/convert/convert_durations.hpp b/cpp/include/cudf/strings/convert/convert_durations.hpp index 396758109f2..6f313f4e563 100644 --- a/cpp/include/cudf/strings/convert/convert_durations.hpp +++ b/cpp/include/cudf/strings/convert/convert_durations.hpp @@ -114,7 +114,7 @@ std::unique_ptr to_durations( * @throw cudf::logic_error if `durations` column parameter is not a duration type. * * @param durations Duration values to convert - * @param format The string specifying output format + * @param format The string specifying output format; * Default format is ""%d days %H:%M:%S". * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column with formatted durations. diff --git a/cpp/include/cudf/strings/detail/convert/fixed_point.cuh b/cpp/include/cudf/strings/detail/convert/fixed_point.cuh index dd0ae1b7846..53fc553024e 100644 --- a/cpp/include/cudf/strings/detail/convert/fixed_point.cuh +++ b/cpp/include/cudf/strings/detail/convert/fixed_point.cuh @@ -121,7 +121,7 @@ __device__ thrust::optional parse_exponent(char const* iter, char const * @brief Converts the string in the range [iter, iter_end) into a decimal. * * @tparam DecimalType The decimal type to be returned - * @param iter The beginning of the string Unless iter >= iter_end, iter is dereferenced + * @param iter The beginning of the string unless iter >= iter_end, iter is dereferenced * @param iter_end The end of the characters to parse * @param scale The scale to be applied * @return diff --git a/cpp/include/cudf/strings/detail/copying.hpp b/cpp/include/cudf/strings/detail/copying.hpp index 3cec8809dc5..b4239bdaa3f 100644 --- a/cpp/include/cudf/strings/detail/copying.hpp +++ b/cpp/include/cudf/strings/detail/copying.hpp @@ -42,7 +42,7 @@ namespace detail { * * @param strings Strings instance for this operation * @param start Index to first string to select in the column (inclusive) - * @param end Index to last string to select in the column (exclusive) + * @param end Index to last string to select in the column (exclusive); * Default -1 indicates the last element. * @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 diff --git a/cpp/include/cudf/strings/detail/utilities.cuh b/cpp/include/cudf/strings/detail/utilities.cuh index 7b3a3a0a55c..0c3ccf08c93 100644 --- a/cpp/include/cudf/strings/detail/utilities.cuh +++ b/cpp/include/cudf/strings/detail/utilities.cuh @@ -107,7 +107,7 @@ __device__ inline char* copy_string(char* buffer, const string_view& d_string) * It must also have members d_offsets and d_chars which are set to * memory containing the offsets and chars columns during write. * - * @param size_and_exec_fn This is called twice. Once for the output size of each string + * @param size_and_exec_fn This is called twice. Once for the output size of each string; * After that, the d_offsets and d_chars are set and this is called again to fill in the * chars memory. * @param exec_size Number of rows for executing the `size_and_exec_fn` function @@ -167,7 +167,7 @@ auto make_strings_children( * It must also have members d_offsets and d_chars which are set to * memory containing the offsets and chars columns during write. * - * @param size_and_exec_fn This is called twice. Once for the output size of each string + * @param size_and_exec_fn This is called twice. Once for the output size of each string; * 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 diff --git a/cpp/include/cudf/strings/find.hpp b/cpp/include/cudf/strings/find.hpp index 4f57520b789..ff8e8fac5ca 100644 --- a/cpp/include/cudf/strings/find.hpp +++ b/cpp/include/cudf/strings/find.hpp @@ -44,7 +44,7 @@ namespace strings { * @param strings Strings instance for this operation * @param target UTF-8 encoded string to search for in each string * @param start First character position to include in the search - * @param stop Last position (exclusive) to include in the search + * @param stop Last position (exclusive) to include in the search; * Default of -1 will search to the end of the string. * @param mr Device memory resource used to allocate the returned column's device memory * @return New integer column with character position values. @@ -73,7 +73,7 @@ std::unique_ptr find( * @param strings Strings instance for this operation * @param target UTF-8 encoded string to search for in each string * @param start First position to include in the search - * @param stop Last position (exclusive) to include in the search + * @param stop Last position (exclusive) to include in the search; * Default of -1 will search starting at the end of the string. * @param mr Device memory resource used to allocate the returned column's device memory * @return New integer column with character position values. diff --git a/cpp/include/cudf/strings/padding.hpp b/cpp/include/cudf/strings/padding.hpp index 95fce5a2c9e..0f270ac9b00 100644 --- a/cpp/include/cudf/strings/padding.hpp +++ b/cpp/include/cudf/strings/padding.hpp @@ -54,9 +54,9 @@ enum class pad_side { * * @param strings Strings instance for this operation * @param width The minimum number of characters for each string - * @param side Where to place the padding characters + * @param side Where to place the padding characters; * Default is pad right (left justify). - * @param fill_char Single UTF-8 character to use for padding + * @param fill_char Single UTF-8 character to use for padding; * Default is the space character. * @param mr Device memory resource used to allocate the returned column's device memory * @return New column with padded strings. diff --git a/cpp/include/cudf/strings/replace.hpp b/cpp/include/cudf/strings/replace.hpp index 4c0cc0ef077..6d5419cb2d0 100644 --- a/cpp/include/cudf/strings/replace.hpp +++ b/cpp/include/cudf/strings/replace.hpp @@ -55,7 +55,7 @@ namespace strings { * @param strings Strings column for this operation * @param target String to search for within each string * @param repl Replacement string if target is found - * @param maxrepl Maximum times to replace if target appears multiple times in the input string + * @param maxrepl Maximum times to replace if target appears multiple times in the input string; * Default of -1 specifies replace all occurrences of target in each string. * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. @@ -93,9 +93,9 @@ std::unique_ptr replace( * @param strings Strings column for this operation * @param repl Replacement string for specified positions found * Default is empty string. - * @param start Start position where repl will be added + * @param start Start position where repl will be added; * Default is 0, first character position. - * @param stop End position (exclusive) to use for replacement + * @param stop End position (exclusive) to use for replacement; * Default of -1 specifies the end of each string. * @param mr Device memory resource used to allocate the returned column's device memory * @return New strings column. diff --git a/cpp/include/cudf/strings/replace_re.hpp b/cpp/include/cudf/strings/replace_re.hpp index ae75367cbf5..b2bfe47137b 100644 --- a/cpp/include/cudf/strings/replace_re.hpp +++ b/cpp/include/cudf/strings/replace_re.hpp @@ -40,7 +40,7 @@ namespace strings { * * @param strings Strings instance for this operation * @param pattern The regular expression pattern to search within each string - * @param replacement The string used to replace the matched sequence in each string + * @param replacement The string used to replace the matched sequence in each string; * Default is an empty string. * @param max_replace_count The maximum number of times to replace the matched pattern * within each string. Default replaces every substring that is matched. diff --git a/cpp/include/cudf/strings/split/partition.hpp b/cpp/include/cudf/strings/split/partition.hpp index 93308e56240..b7bc1b49bfe 100644 --- a/cpp/include/cudf/strings/split/partition.hpp +++ b/cpp/include/cudf/strings/split/partition.hpp @@ -50,7 +50,7 @@ namespace strings { * @endcode * * @param strings Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating where to split each string + * @param delimiter UTF-8 encoded string indicating where to split each string; * Default of empty string indicates split on whitespace. * @param mr Device memory resource used to allocate the returned table's device memory * @return New table of strings columns. @@ -82,7 +82,7 @@ std::unique_ptr
partition( * @endcode * * @param strings Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating where to split each string + * @param delimiter UTF-8 encoded string indicating where to split each string; * Default of empty string indicates split on whitespace. * @param mr Device memory resource used to allocate the returned table's device memory * @return New strings columns. diff --git a/cpp/include/cudf/strings/split/split.hpp b/cpp/include/cudf/strings/split/split.hpp index 35efb016d05..6b3e72dd738 100644 --- a/cpp/include/cudf/strings/split/split.hpp +++ b/cpp/include/cudf/strings/split/split.hpp @@ -42,9 +42,9 @@ namespace strings { * Any null string entries return corresponding null output columns. * * @param strings_column Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating the split points in each string + * @param delimiter UTF-8 encoded string indicating the split points in each string; * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned table's device memory * @return New table of strings columns. @@ -70,9 +70,9 @@ std::unique_ptr
split( * Any null string entries return corresponding null output columns. * * @param strings_column Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating the split points in each string + * @param delimiter UTF-8 encoded string indicating the split points in each string; * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned table's device memory * @return New strings columns. @@ -217,9 +217,9 @@ std::unique_ptr split_record( * @throw cudf:logic_error if `delimiter` is invalid. * * @param strings A column of string elements to be split - * @param delimiter The string to identify split points in each string + * @param delimiter The string to identify split points in each string; * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings diff --git a/cpp/include/cudf/strings/split/split_re.hpp b/cpp/include/cudf/strings/split/split_re.hpp index 1023e6f0e32..6cd5236a779 100644 --- a/cpp/include/cudf/strings/split/split_re.hpp +++ b/cpp/include/cudf/strings/split/split_re.hpp @@ -64,7 +64,7 @@ namespace strings { * * @param input A column of string elements to be split * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned result's device memory * @return A table of columns of strings. @@ -114,7 +114,7 @@ std::unique_ptr
split_re( * * @param input A column of string elements to be split * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned result's device memory * @return A table of columns of strings. @@ -166,7 +166,7 @@ std::unique_ptr
rsplit_re( * * @param input A column of string elements to be split * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings. @@ -220,7 +220,7 @@ std::unique_ptr split_record_re( * * @param input A column of string elements to be split * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform; * Default of -1 indicates all possible splits on each string. * @param mr Device memory resource used to allocate the returned result's device memory * @return Lists column of strings. diff --git a/cpp/include/cudf/strings/string_view.hpp b/cpp/include/cudf/strings/string_view.hpp index 0ccb62bd375..22c99b2640c 100644 --- a/cpp/include/cudf/strings/string_view.hpp +++ b/cpp/include/cudf/strings/string_view.hpp @@ -223,7 +223,7 @@ class string_view { * * @param str Target string to search within this string * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search + * @param count Number of characters from pos to include in the search; * Specify -1 to indicate to the end of the string. * @return -1 if str is not found in this string. */ @@ -237,7 +237,7 @@ class string_view { * @param str Target array to search within this string * @param bytes Number of bytes in str * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search + * @param count Number of characters from pos to include in the search; * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -251,7 +251,7 @@ class string_view { * * @param character Single encoded character * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search + * @param count Number of characters from pos to include in the search; * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -264,7 +264,7 @@ class string_view { * * @param str Target string to search within this string * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search + * @param count Number of characters from pos to include in the search; * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -278,7 +278,7 @@ class string_view { * @param str Target string to search with this string * @param bytes Number of bytes in str * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search + * @param count Number of characters from pos to include in the search; * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -292,7 +292,7 @@ class string_view { * * @param character Single encoded character * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search + * @param count Number of characters from pos to include in the search; * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ diff --git a/cpp/include/cudf/strings/substring.hpp b/cpp/include/cudf/strings/substring.hpp index dbd94e618cc..bfc8ffb8bad 100644 --- a/cpp/include/cudf/strings/substring.hpp +++ b/cpp/include/cudf/strings/substring.hpp @@ -187,7 +187,7 @@ std::unique_ptr slice_strings( * * @param strings Strings instance for this operation * @param delimiter_strings UTF-8 encoded string for each row - * @param count Number of times to search for delimiter in each string If the value is positive, + * @param count Number of times to search for delimiter in each string. If the value is positive, * delimiter is searched from left to right; else, it is searched from right to left. * @param mr Resource for allocating device memory * @return New strings column containing the substrings. From bbb1f459e58c42dcffe02be1e385e3334c30e693 Mon Sep 17 00:00:00 2001 From: Karthikeyan <6488848+karthikeyann@users.noreply.github.com> Date: Sat, 28 May 2022 05:54:26 +0530 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: David Wendt <45795991+davidwendt@users.noreply.github.com> --- cpp/include/cudf/strings/char_types/char_types.hpp | 2 +- cpp/include/cudf/strings/combine.hpp | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cpp/include/cudf/strings/char_types/char_types.hpp b/cpp/include/cudf/strings/char_types/char_types.hpp index 3c0c99d6f11..59bbae9c36d 100644 --- a/cpp/include/cudf/strings/char_types/char_types.hpp +++ b/cpp/include/cudf/strings/char_types/char_types.hpp @@ -92,7 +92,7 @@ string_character_types& operator|=(string_character_types& lhs, string_character * * @param strings Strings instance for this operation * @param types The character types to check in each string - * @param verify_types Only verify against these character types + * @param verify_types Only verify against these character types. * Default `ALL_TYPES` means return `true` * iff all characters match `types`. * @param mr Device memory resource used to allocate the returned column's device memory diff --git a/cpp/include/cudf/strings/combine.hpp b/cpp/include/cudf/strings/combine.hpp index 1f65ac13600..94af25b35aa 100644 --- a/cpp/include/cudf/strings/combine.hpp +++ b/cpp/include/cudf/strings/combine.hpp @@ -65,9 +65,9 @@ enum class output_if_empty_list { * @throw cudf::logic_error if separator is not valid. * * @param strings Strings for this operation - * @param separator String that should inserted between each string + * @param separator String that should inserted between each string. * Default is an empty string. - * @param narep String that should represent any null strings found + * @param narep String that should represent any null strings found. * Default of invalid-scalar will ignore any null entries. * @param mr Device memory resource used to allocate the returned column's device memory * @return New column containing one string. @@ -183,7 +183,7 @@ std::unique_ptr concatenate( * @throw cudf::logic_error if only one column is specified * * @param strings_columns List of string columns to concatenate - * @param separator String that should inserted between each string from each row + * @param separator String that should inserted between each string from each row. * Default is an empty string. * @param narep String that should be used in place of any null strings * found in any column. Default of invalid-scalar means any null entry in any column will From 2c3b88c370bfb19f62822703ed490cb452ff5f30 Mon Sep 17 00:00:00 2001 From: Karthikeyan <6488848+karthikeyann@users.noreply.github.com> Date: Wed, 1 Jun 2022 18:04:04 +0530 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: David Wendt <45795991+davidwendt@users.noreply.github.com> --- .../cudf/strings/detail/convert/fixed_point.cuh | 2 +- cpp/include/cudf/strings/detail/utilities.cuh | 10 ++++------ cpp/include/cudf/strings/replace.hpp | 2 +- cpp/include/cudf/strings/substring.hpp | 2 +- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/cpp/include/cudf/strings/detail/convert/fixed_point.cuh b/cpp/include/cudf/strings/detail/convert/fixed_point.cuh index 53fc553024e..34954b81819 100644 --- a/cpp/include/cudf/strings/detail/convert/fixed_point.cuh +++ b/cpp/include/cudf/strings/detail/convert/fixed_point.cuh @@ -121,7 +121,7 @@ __device__ thrust::optional parse_exponent(char const* iter, char const * @brief Converts the string in the range [iter, iter_end) into a decimal. * * @tparam DecimalType The decimal type to be returned - * @param iter The beginning of the string unless iter >= iter_end, iter is dereferenced + * @param iter The beginning of the string * @param iter_end The end of the characters to parse * @param scale The scale to be applied * @return diff --git a/cpp/include/cudf/strings/detail/utilities.cuh b/cpp/include/cudf/strings/detail/utilities.cuh index 0c3ccf08c93..82cf82a71ee 100644 --- a/cpp/include/cudf/strings/detail/utilities.cuh +++ b/cpp/include/cudf/strings/detail/utilities.cuh @@ -107,9 +107,8 @@ __device__ inline char* copy_string(char* buffer, const string_view& d_string) * It must also have members d_offsets and d_chars which are set to * memory containing the offsets and chars columns during write. * - * @param size_and_exec_fn This is called twice. Once for the output size of each string; - * After that, the d_offsets and d_chars are set and this is called again to fill in the - * chars memory. + * @param size_and_exec_fn This is called twice. Once for the output size of each string + * and once again to fill in the memory pointed to by d_chars. * @param exec_size Number of rows for executing the `size_and_exec_fn` function * @param strings_count Number of strings * @param stream CUDA stream used for device memory operations and kernel launches @@ -167,9 +166,8 @@ auto make_strings_children( * It must also have members d_offsets and d_chars which are set to * memory containing the offsets and chars columns during write. * - * @param size_and_exec_fn This is called twice. Once for the output size of each string; - * After that, the d_offsets and d_chars are set and this is called again to fill in the - * chars memory. + * @param size_and_exec_fn This is called twice. Once for the output size of each string + * and once again to fill in the memory pointed to by d_chars. * @param strings_count Number of strings * @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 diff --git a/cpp/include/cudf/strings/replace.hpp b/cpp/include/cudf/strings/replace.hpp index 6d5419cb2d0..8fd307ebf1e 100644 --- a/cpp/include/cudf/strings/replace.hpp +++ b/cpp/include/cudf/strings/replace.hpp @@ -91,7 +91,7 @@ std::unique_ptr replace( * @throw cudf::logic_error if start is greater than stop. * * @param strings Strings column for this operation - * @param repl Replacement string for specified positions found + * @param repl Replacement string for specified positions found; * Default is empty string. * @param start Start position where repl will be added; * Default is 0, first character position. diff --git a/cpp/include/cudf/strings/substring.hpp b/cpp/include/cudf/strings/substring.hpp index bfc8ffb8bad..ae76e390210 100644 --- a/cpp/include/cudf/strings/substring.hpp +++ b/cpp/include/cudf/strings/substring.hpp @@ -137,7 +137,7 @@ std::unique_ptr slice_strings( * * @param strings Strings instance for this operation * @param delimiter UTF-8 encoded string to search for in each string - * @param count Number of times to search for delimiter in each string If the value is positive, + * @param count Number of times to search for delimiter in each string. If the value is positive, * delimiter is searched from left to right; else, it is searched from right to left. * @param mr Resource for allocating device memory * @return New strings column containing the substrings. From b3603f2eeeb55dd1eb817e7b788ec2fbe6e60bf6 Mon Sep 17 00:00:00 2001 From: Karthikeyan Natarajan Date: Wed, 1 Jun 2022 20:25:24 +0530 Subject: [PATCH 6/6] Revert "remove . dot at end of @param" This reverts commit 771cd46a57856f4c6ca7956a4b20f59541f1b1d3. --- cpp/include/cudf/strings/attributes.hpp | 14 ++-- cpp/include/cudf/strings/capitalize.hpp | 12 ++-- cpp/include/cudf/strings/case.hpp | 14 ++-- .../cudf/strings/char_types/char_types.hpp | 14 ++-- cpp/include/cudf/strings/combine.hpp | 30 ++++---- cpp/include/cudf/strings/contains.hpp | 24 +++---- .../cudf/strings/convert/convert_booleans.hpp | 16 ++--- .../cudf/strings/convert/convert_datetime.hpp | 20 +++--- .../strings/convert/convert_durations.hpp | 14 ++-- .../strings/convert/convert_fixed_point.hpp | 18 ++--- .../cudf/strings/convert/convert_floats.hpp | 16 ++--- .../cudf/strings/convert/convert_integers.hpp | 36 +++++----- .../cudf/strings/convert/convert_ipv4.hpp | 14 ++-- .../cudf/strings/convert/convert_lists.hpp | 8 +-- .../cudf/strings/convert/convert_urls.hpp | 10 +-- cpp/include/cudf/strings/detail/combine.hpp | 6 +- .../cudf/strings/detail/concatenate.hpp | 8 +-- .../cudf/strings/detail/converters.hpp | 24 +++---- .../cudf/strings/detail/copy_if_else.cuh | 12 ++-- .../cudf/strings/detail/copy_range.cuh | 6 +- cpp/include/cudf/strings/detail/copying.hpp | 22 +++--- cpp/include/cudf/strings/detail/fill.hpp | 14 ++-- cpp/include/cudf/strings/detail/gather.cuh | 56 +++++++-------- cpp/include/cudf/strings/detail/merge.cuh | 10 +-- cpp/include/cudf/strings/detail/replace.hpp | 16 ++--- cpp/include/cudf/strings/detail/scatter.cuh | 6 +- cpp/include/cudf/strings/detail/utf8.hpp | 8 +-- cpp/include/cudf/strings/detail/utilities.cuh | 28 ++++---- cpp/include/cudf/strings/detail/utilities.hpp | 12 ++-- cpp/include/cudf/strings/extract.hpp | 16 ++--- cpp/include/cudf/strings/find.hpp | 58 ++++++++-------- cpp/include/cudf/strings/find_multiple.hpp | 6 +- cpp/include/cudf/strings/findall.hpp | 16 ++--- cpp/include/cudf/strings/json.hpp | 8 +-- cpp/include/cudf/strings/padding.hpp | 16 ++--- cpp/include/cudf/strings/repeat_strings.hpp | 22 +++--- cpp/include/cudf/strings/replace.hpp | 30 ++++---- cpp/include/cudf/strings/replace_re.hpp | 30 ++++---- cpp/include/cudf/strings/split/partition.hpp | 14 ++-- cpp/include/cudf/strings/split/split.hpp | 34 +++++----- cpp/include/cudf/strings/split/split_re.hpp | 32 ++++----- cpp/include/cudf/strings/string.cuh | 4 +- cpp/include/cudf/strings/string_view.cuh | 4 +- cpp/include/cudf/strings/string_view.hpp | 68 +++++++++---------- .../cudf/strings/strings_column_view.hpp | 4 +- cpp/include/cudf/strings/strip.hpp | 8 +-- cpp/include/cudf/strings/substring.hpp | 32 ++++----- cpp/include/cudf/strings/translate.hpp | 16 ++--- cpp/include/cudf/strings/wrap.hpp | 6 +- 49 files changed, 456 insertions(+), 456 deletions(-) diff --git a/cpp/include/cudf/strings/attributes.hpp b/cpp/include/cudf/strings/attributes.hpp index a4be3ee54c8..5babe3f3fa0 100644 --- a/cpp/include/cudf/strings/attributes.hpp +++ b/cpp/include/cudf/strings/attributes.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,8 +39,8 @@ namespace strings { * * Any null string will result in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT32 column with lengths for each string. */ std::unique_ptr count_characters( @@ -57,8 +57,8 @@ std::unique_ptr count_characters( * * Any null string will result in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT32 column with the number of bytes for each string. */ std::unique_ptr count_bytes( @@ -77,8 +77,8 @@ std::unique_ptr count_bytes( * * Any null string is ignored. No null entries will appear in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT32 column with code point integer values for each character. */ std::unique_ptr code_points( diff --git a/cpp/include/cudf/strings/capitalize.hpp b/cpp/include/cudf/strings/capitalize.hpp index 042e367150f..dbf8ef54e3e 100644 --- a/cpp/include/cudf/strings/capitalize.hpp +++ b/cpp/include/cudf/strings/capitalize.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2022, NVIDIA CORPORATION. + * Copyright (c) 2020-2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -50,8 +50,8 @@ namespace strings { * * @throw cudf::logic_error if `delimiter.is_valid()` is `false`. * - * @param input String column - * @param delimiters Characters for identifying words to capitalize + * @param input String column. + * @param delimiters Characters for identifying words to capitalize. * @param mr Device memory resource used to allocate the returned column's device memory * @return Column of strings capitalized from the input column. */ @@ -81,8 +81,8 @@ std::unique_ptr capitalize( * * Any null string entries return corresponding null output column entries. * - * @param input String column - * @param sequence_type The character type that is used when identifying words + * @param input String column. + * @param sequence_type The character type that is used when identifying words. * @param mr Device memory resource used to allocate the returned column's device memory * @return Column of titled strings. */ @@ -110,7 +110,7 @@ std::unique_ptr title( * * Any null string entries result in corresponding null output column entries. * - * @param input String column + * @param input String column. * @param mr Device memory resource used to allocate the returned column's device memory * @return Column of type BOOL8. */ diff --git a/cpp/include/cudf/strings/case.hpp b/cpp/include/cudf/strings/case.hpp index 89af0171cd3..bf746d80b3b 100644 --- a/cpp/include/cudf/strings/case.hpp +++ b/cpp/include/cudf/strings/case.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,8 +35,8 @@ namespace strings { * * Any null entries create null entries in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of strings with characters converted. */ std::unique_ptr to_lower( @@ -52,8 +52,8 @@ std::unique_ptr to_lower( * * Any null entries create null entries in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of strings with characters converted. */ std::unique_ptr to_upper( @@ -70,8 +70,8 @@ std::unique_ptr to_upper( * * Any null entries create null entries in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of strings with characters converted. */ std::unique_ptr swapcase( diff --git a/cpp/include/cudf/strings/char_types/char_types.hpp b/cpp/include/cudf/strings/char_types/char_types.hpp index 59bbae9c36d..a5a90f74c21 100644 --- a/cpp/include/cudf/strings/char_types/char_types.hpp +++ b/cpp/include/cudf/strings/char_types/char_types.hpp @@ -90,12 +90,12 @@ string_character_types& operator|=(string_character_types& lhs, string_character * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param types The character types to check in each string + * @param strings Strings instance for this operation. + * @param types The character types to check in each string. * @param verify_types Only verify against these character types. * Default `ALL_TYPES` means return `true` * iff all characters match `types`. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr all_characters_of_type( @@ -133,13 +133,13 @@ std::unique_ptr all_characters_of_type( * @throw cudf::logic_error if neither or both `types_to_remove` and * `types_to_keep` are set to `ALL_TYPES`. * - * @param strings Strings instance for this operation - * @param types_to_remove The character types to check in each string + * @param strings Strings instance for this operation. + * @param types_to_remove The character types to check in each string. * Use `ALL_TYPES` here to specify `types_to_keep` instead. - * @param replacement The replacement character to use when removing characters + * @param replacement The replacement character to use when removing characters. * @param types_to_keep Default `ALL_TYPES` means all characters of * `types_to_remove` will be filtered. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr filter_characters_of_type( diff --git a/cpp/include/cudf/strings/combine.hpp b/cpp/include/cudf/strings/combine.hpp index 94af25b35aa..32f8d482a34 100644 --- a/cpp/include/cudf/strings/combine.hpp +++ b/cpp/include/cudf/strings/combine.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -64,12 +64,12 @@ enum class output_if_empty_list { * * @throw cudf::logic_error if separator is not valid. * - * @param strings Strings for this operation + * @param strings Strings for this operation. * @param separator String that should inserted between each string. * Default is an empty string. * @param narep String that should represent any null strings found. * Default of invalid-scalar will ignore any null entries. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column containing one string. */ std::unique_ptr join_strings( @@ -125,7 +125,7 @@ std::unique_ptr join_strings( * @throw cudf::logic_error if the number of rows from @p separators and @p strings_columns * do not match * - * @param strings_columns List of strings columns to concatenate + * @param strings_columns List of strings columns to concatenate. * @param separators Strings column that provides the separator for a given row * @param separator_narep String that should be used in place of a null separator for a given * row. Default of invalid-scalar means no row separator value replacements. @@ -135,7 +135,7 @@ std::unique_ptr join_strings( * Default is an invalid string. * @param separate_nulls If YES, then the separator is included for null rows * if `col_narep` is valid. - * @param mr Resource for allocating device memory + * @param mr Resource for allocating device memory. * @return New column with concatenated results. */ std::unique_ptr concatenate( @@ -182,14 +182,14 @@ std::unique_ptr concatenate( * @throw cudf::logic_error if separator is not valid. * @throw cudf::logic_error if only one column is specified * - * @param strings_columns List of string columns to concatenate + * @param strings_columns List of string columns to concatenate. * @param separator String that should inserted between each string from each row. * Default is an empty string. * @param narep String that should be used in place of any null strings * found in any column. Default of invalid-scalar means any null entry in any column will * produces a null result for that row. - * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid - * @param mr Device memory resource used to allocate the returned column's device memory + * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with concatenated results. */ std::unique_ptr concatenate( @@ -241,18 +241,18 @@ std::unique_ptr concatenate( * @throw cudf::logic_error if the number of rows from `separators` and `lists_strings_column` do * not match * - * @param lists_strings_column Column containing lists of strings to concatenate - * @param separators Strings column that provides separators for concatenation + * @param lists_strings_column Column containing lists of strings to concatenate. + * @param separators Strings column that provides separators for concatenation. * @param separator_narep String that should be used to replace null separator, default is an * invalid-scalar denoting that rows containing null separator will result in null string in * the corresponding output rows. * @param string_narep String that should be used to replace null strings in any non-null list row, * default is an invalid-scalar denoting that list rows containing null strings will result * in null string in the corresponding output rows. - * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid + * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid. * @param empty_list_policy if set to EMPTY_STRING, any input row that is an empty list will * result in an empty string. Otherwise, it will result in a null. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with concatenated results. */ std::unique_ptr join_list_elements( @@ -301,16 +301,16 @@ std::unique_ptr join_list_elements( * @throw cudf::logic_error if input column is not lists of strings column. * @throw cudf::logic_error if separator is not valid. * - * @param lists_strings_column Column containing lists of strings to concatenate + * @param lists_strings_column Column containing lists of strings to concatenate. * @param separator String that should inserted between strings of each list row, default is an * empty string. * @param narep String that should be used to replace null strings in any non-null list row, default * is an invalid-scalar denoting that list rows containing null strings will result in null * string in the corresponding output rows. - * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid + * @param separate_nulls If YES, then the separator is included for null rows if `narep` is valid. * @param empty_list_policy if set to EMPTY_STRING, any input row that is an empty list will result * in an empty string. Otherwise, it will result in a null. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with concatenated results. */ std::unique_ptr join_list_elements( diff --git a/cpp/include/cudf/strings/contains.hpp b/cpp/include/cudf/strings/contains.hpp index 507322a66b5..5b8b2f56bae 100644 --- a/cpp/include/cudf/strings/contains.hpp +++ b/cpp/include/cudf/strings/contains.hpp @@ -43,10 +43,10 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param pattern Regex pattern to match to each string - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param pattern Regex pattern to match to each string. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr contains_re( @@ -70,10 +70,10 @@ std::unique_ptr contains_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param pattern Regex pattern to match to each string - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param pattern Regex pattern to match to each string. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr matches_re( @@ -97,10 +97,10 @@ std::unique_ptr matches_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param pattern Regex pattern to match within each string - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param pattern Regex pattern to match within each string. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT32 column with counts for each string. */ std::unique_ptr count_re( diff --git a/cpp/include/cudf/strings/convert/convert_booleans.hpp b/cpp/include/cudf/strings/convert/convert_booleans.hpp index 459b0f837b4..644068a62f3 100644 --- a/cpp/include/cudf/strings/convert/convert_booleans.hpp +++ b/cpp/include/cudf/strings/convert/convert_booleans.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,9 +33,9 @@ namespace strings { * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation - * @param true_string String to expect for true. Non-matching strings are false - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param true_string String to expect for true. Non-matching strings are false. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New BOOL8 column converted from strings. */ std::unique_ptr to_booleans( @@ -51,10 +51,10 @@ std::unique_ptr to_booleans( * * @throw cudf::logic_error if the input column is not BOOL8 type. * - * @param booleans Boolean column to convert - * @param true_string String to use for true in the output column - * @param false_string String to use for false in the output column - * @param mr Device memory resource used to allocate the returned column's device memory + * @param booleans Boolean column to convert. + * @param true_string String to use for true in the output column. + * @param false_string String to use for false in the output column. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr from_booleans( diff --git a/cpp/include/cudf/strings/convert/convert_datetime.hpp b/cpp/include/cudf/strings/convert/convert_datetime.hpp index cb488c3773e..3c3e40a1f0e 100644 --- a/cpp/include/cudf/strings/convert/convert_datetime.hpp +++ b/cpp/include/cudf/strings/convert/convert_datetime.hpp @@ -65,10 +65,10 @@ namespace strings { * * @throw cudf::logic_error if timestamp_type is not a timestamp type. * - * @param strings Strings instance for this operation - * @param timestamp_type The timestamp type used for creating the output column - * @param format String specifying the timestamp format in strings - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param timestamp_type The timestamp type used for creating the output column. + * @param format String specifying the timestamp format in strings. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New datetime column. */ std::unique_ptr to_timestamps( @@ -108,9 +108,9 @@ std::unique_ptr to_timestamps( * This will return a column of type BOOL8 where a `true` row indicates the corresponding * input string can be parsed correctly with the given format. * - * @param strings Strings instance for this operation - * @param format String specifying the timestamp format in strings - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param format String specifying the timestamp format in strings. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New BOOL8 column. */ std::unique_ptr is_timestamp( @@ -215,12 +215,12 @@ std::unique_ptr is_timestamp( * @throw cudf::logic_error if the `format` string is empty * @throw cudf::logic_error if `names.size()` is an invalid size. Must be 0 or 40 strings. * - * @param timestamps Timestamp values to convert - * @param format The string specifying output format; + * @param timestamps Timestamp values to convert. + * @param format The string specifying output format. * Default format is "%Y-%m-%dT%H:%M:%SZ". * @param names The string names to use for weekdays ("%a", "%A") and months ("%b", "%B") * Default is an empty `strings_column_view`. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with formatted timestamps. */ std::unique_ptr from_timestamps( diff --git a/cpp/include/cudf/strings/convert/convert_durations.hpp b/cpp/include/cudf/strings/convert/convert_durations.hpp index 6f313f4e563..ac96a2c2fc6 100644 --- a/cpp/include/cudf/strings/convert/convert_durations.hpp +++ b/cpp/include/cudf/strings/convert/convert_durations.hpp @@ -63,10 +63,10 @@ namespace strings { * * @throw cudf::logic_error if duration_type is not a duration type. * - * @param strings Strings instance for this operation - * @param duration_type The duration type used for creating the output column - * @param format String specifying the duration format in strings - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param duration_type The duration type used for creating the output column. + * @param format String specifying the duration format in strings. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New duration column. */ std::unique_ptr to_durations( @@ -113,10 +113,10 @@ std::unique_ptr to_durations( * * @throw cudf::logic_error if `durations` column parameter is not a duration type. * - * @param durations Duration values to convert - * @param format The string specifying output format; + * @param durations Duration values to convert. + * @param format The string specifying output format. * Default format is ""%d days %H:%M:%S". - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with formatted durations. */ std::unique_ptr from_durations( diff --git a/cpp/include/cudf/strings/convert/convert_fixed_point.hpp b/cpp/include/cudf/strings/convert/convert_fixed_point.hpp index 5805f5da496..5fe5c880f9d 100644 --- a/cpp/include/cudf/strings/convert/convert_fixed_point.hpp +++ b/cpp/include/cudf/strings/convert/convert_fixed_point.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2022, NVIDIA CORPORATION. + * Copyright (c) 2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,9 +51,9 @@ namespace strings { * * @throw cudf::logic_error if `output_type` is not a fixed-point decimal type. * - * @param input Strings instance for this operation - * @param output_type Type of fixed-point column to return including the scale value - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Strings instance for this operation. + * @param output_type Type of fixed-point column to return including the scale value. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of `output_type`. */ std::unique_ptr to_fixed_point( @@ -81,8 +81,8 @@ std::unique_ptr to_fixed_point( * * @throw cudf::logic_error if the `input` column is not a fixed-point decimal type. * - * @param input Fixed-point column to convert - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Fixed-point column to convert. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr from_fixed_point( @@ -109,9 +109,9 @@ std::unique_ptr from_fixed_point( * * @throw cudf::logic_error if the `decimal_type` is not a fixed-point decimal type. * - * @param input Strings instance for this operation - * @param decimal_type Fixed-point type (with scale) used only for checking overflow - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Strings instance for this operation. + * @param decimal_type Fixed-point type (with scale) used only for checking overflow. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr is_fixed_point( diff --git a/cpp/include/cudf/strings/convert/convert_floats.hpp b/cpp/include/cudf/strings/convert/convert_floats.hpp index 89962faa3bd..d1e00b36f6f 100644 --- a/cpp/include/cudf/strings/convert/convert_floats.hpp +++ b/cpp/include/cudf/strings/convert/convert_floats.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2022, NVIDIA CORPORATION. + * Copyright (c) 2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -37,9 +37,9 @@ namespace strings { * * @throw cudf::logic_error if output_type is not float type. * - * @param strings Strings instance for this operation - * @param output_type Type of float numeric column to return - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param output_type Type of float numeric column to return. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with floats converted from strings. */ std::unique_ptr to_floats( @@ -60,8 +60,8 @@ std::unique_ptr to_floats( * * @throw cudf::logic_error if floats column is not float type. * - * @param floats Numeric column to convert - * @param mr Device memory resource used to allocate the returned column's device memory + * @param floats Numeric column to convert. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with floats as strings. */ std::unique_ptr from_floats( @@ -84,8 +84,8 @@ std::unique_ptr from_floats( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr is_float( diff --git a/cpp/include/cudf/strings/convert/convert_integers.hpp b/cpp/include/cudf/strings/convert/convert_integers.hpp index ea03c027662..17430d3eafe 100644 --- a/cpp/include/cudf/strings/convert/convert_integers.hpp +++ b/cpp/include/cudf/strings/convert/convert_integers.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2022, NVIDIA CORPORATION. + * Copyright (c) 2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -44,9 +44,9 @@ namespace strings { * * @throw cudf::logic_error if output_type is not integral type. * - * @param strings Strings instance for this operation - * @param output_type Type of integer numeric column to return - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param output_type Type of integer numeric column to return. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with integers converted from strings. */ std::unique_ptr to_integers( @@ -65,8 +65,8 @@ std::unique_ptr to_integers( * * @throw cudf::logic_error if integers column is not integral type. * - * @param integers Numeric column to convert - * @param mr Device memory resource used to allocate the returned column's device memory + * @param integers Numeric column to convert. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with integers as strings. */ std::unique_ptr from_integers( @@ -92,8 +92,8 @@ std::unique_ptr from_integers( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr is_integer( @@ -122,9 +122,9 @@ std::unique_ptr is_integer( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param int_type Integer type used for checking underflow and overflow - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param int_type Integer type used for checking underflow and overflow. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr is_integer( @@ -150,9 +150,9 @@ std::unique_ptr is_integer( * * @throw cudf::logic_error if output_type is not integral type. * - * @param strings Strings instance for this operation - * @param output_type Type of integer numeric column to return - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param output_type Type of integer numeric column to return. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with integers converted from strings. */ std::unique_ptr hex_to_integers( @@ -177,8 +177,8 @@ std::unique_ptr hex_to_integers( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr is_hex( @@ -208,8 +208,8 @@ std::unique_ptr is_hex( * * @throw cudf::logic_error if the input column is not integral type. * - * @param input Integer column to convert to hex - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Integer column to convert to hex. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with hexadecimal characters. */ std::unique_ptr integers_to_hex( diff --git a/cpp/include/cudf/strings/convert/convert_ipv4.hpp b/cpp/include/cudf/strings/convert/convert_ipv4.hpp index 667660d884a..80e3c89be2d 100644 --- a/cpp/include/cudf/strings/convert/convert_ipv4.hpp +++ b/cpp/include/cudf/strings/convert/convert_ipv4.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -46,8 +46,8 @@ namespace strings { * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New INT64 column converted from strings. */ std::unique_ptr ipv4_to_integers( @@ -69,8 +69,8 @@ std::unique_ptr ipv4_to_integers( * * @throw cudf::logic_error if the input column is not INT64 type. * - * @param integers Integer (INT64) column to convert - * @param mr Device memory resource used to allocate the returned column's device memory + * @param integers Integer (INT64) column to convert. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr integers_to_ipv4( @@ -94,8 +94,8 @@ std::unique_ptr integers_to_ipv4( * * Any null row results in a null entry for that row in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of boolean results for each string. */ std::unique_ptr is_ipv4( diff --git a/cpp/include/cudf/strings/convert/convert_lists.hpp b/cpp/include/cudf/strings/convert/convert_lists.hpp index 8b7cbdf093a..91b0e533f71 100644 --- a/cpp/include/cudf/strings/convert/convert_lists.hpp +++ b/cpp/include/cudf/strings/convert/convert_lists.hpp @@ -48,10 +48,10 @@ namespace strings { * * @throw cudf::logic_error if the input column is not a LIST type with a STRING child. * - * @param input Lists column to format - * @param na_rep Replacement string for null elements - * @param separators Strings to use for enclosing list components and separating elements - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Lists column to format. + * @param na_rep Replacement string for null elements. + * @param separators Strings to use for enclosing list components and separating elements. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr format_list_column( diff --git a/cpp/include/cudf/strings/convert/convert_urls.hpp b/cpp/include/cudf/strings/convert/convert_urls.hpp index a2f378539de..a8893ab9dfd 100644 --- a/cpp/include/cudf/strings/convert/convert_urls.hpp +++ b/cpp/include/cudf/strings/convert/convert_urls.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -37,8 +37,8 @@ namespace strings { * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr url_encode( @@ -58,8 +58,8 @@ std::unique_ptr url_encode( * * Any null entries will result in corresponding null entries in the output column. * - * @param strings Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr url_decode( diff --git a/cpp/include/cudf/strings/detail/combine.hpp b/cpp/include/cudf/strings/detail/combine.hpp index 34e80568508..50f9a70e21c 100644 --- a/cpp/include/cudf/strings/detail/combine.hpp +++ b/cpp/include/cudf/strings/detail/combine.hpp @@ -31,7 +31,7 @@ namespace detail { * @copydoc concatenate(table_view const&,string_scalar const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr concatenate( table_view const& strings_columns, @@ -45,7 +45,7 @@ std::unique_ptr concatenate( * @copydoc join_strings(table_view const&,string_scalar const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr join_strings( strings_column_view const& strings, @@ -58,7 +58,7 @@ std::unique_ptr join_strings( * @copydoc join_list_elements(table_view const&,string_scalar const&,string_scalar * const&,separator_on_nulls,output_if_empty_list,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr join_list_elements(lists_column_view const& lists_strings_column, string_scalar const& separator, diff --git a/cpp/include/cudf/strings/detail/concatenate.hpp b/cpp/include/cudf/strings/detail/concatenate.hpp index ef6a107c7ea..3512c05a586 100644 --- a/cpp/include/cudf/strings/detail/concatenate.hpp +++ b/cpp/include/cudf/strings/detail/concatenate.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,9 +36,9 @@ namespace detail { * r is now ['aa', 'bb', 'cc', 'dd', 'ee'] * ``` * - * @param columns List of string columns to concatenate - * @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 + * @param columns List of string columns to concatenate. + * @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/converters.hpp b/cpp/include/cudf/strings/detail/converters.hpp index 3b442a526ed..3337815342c 100644 --- a/cpp/include/cudf/strings/detail/converters.hpp +++ b/cpp/include/cudf/strings/detail/converters.hpp @@ -28,7 +28,7 @@ namespace detail { /** * @copydoc to_integers(strings_column_view const&,data_type,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr to_integers(strings_column_view const& strings, data_type output_type, @@ -38,7 +38,7 @@ std::unique_ptr to_integers(strings_column_view const& strings, /** * @copydoc from_integers(strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr from_integers(column_view const& integers, rmm::cuda_stream_view stream, @@ -47,7 +47,7 @@ std::unique_ptr from_integers(column_view const& integers, /** * @copydoc to_floats(strings_column_view const&,data_type,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr to_floats(strings_column_view const& strings, data_type output_type, @@ -57,7 +57,7 @@ std::unique_ptr to_floats(strings_column_view const& strings, /** * @copydoc from_floats(strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr from_floats(column_view const& floats, rmm::cuda_stream_view stream, @@ -67,7 +67,7 @@ std::unique_ptr from_floats(column_view const& floats, * @copydoc to_booleans(strings_column_view const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr to_booleans(strings_column_view const& strings, string_scalar const& true_string, @@ -78,7 +78,7 @@ std::unique_ptr to_booleans(strings_column_view const& strings, * @copydoc from_booleans(strings_column_view const&,string_scalar const&,string_scalar * const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr from_booleans(column_view const& booleans, string_scalar const& true_string, @@ -90,7 +90,7 @@ std::unique_ptr from_booleans(column_view const& booleans, * @copydoc to_timestamps(strings_column_view const&,data_type,std::string_view, * rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr to_timestamps(strings_column_view const& strings, data_type timestamp_type, @@ -102,7 +102,7 @@ std::unique_ptr to_timestamps(strings_column_view const& strings, * @copydoc from_timestamps(strings_column_view const&,std::string_view, * strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr from_timestamps(column_view const& timestamps, std::string_view format, @@ -114,7 +114,7 @@ std::unique_ptr from_timestamps(column_view const& timestamps, * @copydoc to_durations(strings_column_view const&,data_type,std::string_view, * rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr to_durations(strings_column_view const& strings, data_type duration_type, @@ -126,7 +126,7 @@ std::unique_ptr to_durations(strings_column_view const& strings, * @copydoc from_durations(strings_column_view const&,std::string_view. * rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr from_durations(column_view const& durations, std::string_view format, @@ -136,7 +136,7 @@ std::unique_ptr from_durations(column_view const& durations, /** * @copydoc to_fixed_point(strings_column_view const&,data_type,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr to_fixed_point(strings_column_view const& strings, data_type output_type, @@ -146,7 +146,7 @@ std::unique_ptr to_fixed_point(strings_column_view const& strings, /** * @copydoc from_fixed_point(strings_column_view const&,rmm::mr::device_memory_resource*) * - * @param stream CUDA stream used for device memory operations and kernel launches + * @param stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr from_fixed_point(column_view const& integers, rmm::cuda_stream_view stream, diff --git a/cpp/include/cudf/strings/detail/copy_if_else.cuh b/cpp/include/cudf/strings/detail/copy_if_else.cuh index f755ee5dd7d..79cec779e02 100644 --- a/cpp/include/cudf/strings/detail/copy_if_else.cuh +++ b/cpp/include/cudf/strings/detail/copy_if_else.cuh @@ -47,12 +47,12 @@ namespace detail { * `thrust::optional` where the `optional` has a value iff the element is valid. * @tparam Filter Functor that takes an index and returns a boolean. * - * @param lhs_begin Start of first set of data. Used when `filter_fn` returns true - * @param lhs_end End of first set of data - * @param rhs_begin Strings of second set of data. Used when `filter_fn` returns false - * @param filter_fn Called to determine which iterator to use for a specific row - * @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 + * @param lhs_begin Start of first set of data. Used when `filter_fn` returns true. + * @param lhs_end End of first set of data. + * @param rhs_begin Strings of second set of data. Used when `filter_fn` returns false. + * @param filter_fn Called to determine which iterator to use for a specific row. + * @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 cfa3556d2e9..e83f6dc0005 100644 --- a/cpp/include/cudf/strings/detail/copy_range.cuh +++ b/cpp/include/cudf/strings/detail/copy_range.cuh @@ -90,12 +90,12 @@ namespace detail { * @tparam SourceValidityIterator Iterator for retrieving source validities * @param source_value_begin Start of source value iterator * @param source_validity_begin Start of source validity iterator - * @param target The strings column to copy from outside the range + * @param target The strings column to copy from outside the range. * @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 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 + * @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/copying.hpp b/cpp/include/cudf/strings/detail/copying.hpp index b4239bdaa3f..6083ebc4a62 100644 --- a/cpp/include/cudf/strings/detail/copying.hpp +++ b/cpp/include/cudf/strings/detail/copying.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -40,12 +40,12 @@ namespace detail { * s2 is ["b", "c"] * @endcode * - * @param strings Strings instance for this operation - * @param start Index to first string to select in the column (inclusive) - * @param end Index to last string to select in the column (exclusive); + * @param strings Strings instance for this operation. + * @param start Index to first string to select in the column (inclusive). + * @param end Index to last string to select in the column (exclusive). * Default -1 indicates the last element. - * @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 + * @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 of size (end-start)/step. */ std::unique_ptr copy_slice( @@ -69,11 +69,11 @@ std::unique_ptr copy_slice( * * The caller should set the validity mask in the output column. * - * @param input Strings instance for this operation - * @param offset The offset by which to shift the input - * @param fill_value Fill value for indeterminable outputs - * @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 + * @param input Strings instance for this operation. + * @param offset The offset by which to shift the input. + * @param fill_value Fill value for indeterminable outputs. + * @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 shift(strings_column_view const& input, diff --git a/cpp/include/cudf/strings/detail/fill.hpp b/cpp/include/cudf/strings/detail/fill.hpp index 3b2c174b276..040175af9e5 100644 --- a/cpp/include/cudf/strings/detail/fill.hpp +++ b/cpp/include/cudf/strings/detail/fill.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2020, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,12 +33,12 @@ namespace detail { * * @throw cudf::logic_error if [begin,end) is outside the range of the input column. * - * @param strings Strings column to fill - * @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 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 + * @param strings Strings column to fill. + * @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 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 e122d70287a..d46ab3a91a1 100644 --- a/cpp/include/cudf/strings/detail/gather.cuh +++ b/cpp/include/cudf/strings/detail/gather.cuh @@ -68,11 +68,11 @@ __forceinline__ __device__ uint4 load_uint4(const char* ptr) * @tparam StringIterator Iterator should produce `string_view` objects. * @tparam MapIterator Iterator for retrieving integer indices of the `StringIterator`. * - * @param strings_begin Start of the iterator to retrieve `string_view` instances - * @param out_chars Output buffer for gathered characters - * @param out_offsets The offset values associated with the output buffer - * @param string_indices Start of index iterator - * @param total_out_strings Number of output strings to be gathered + * @param strings_begin Start of the iterator to retrieve `string_view` instances. + * @param out_chars Output buffer for gathered characters. + * @param out_offsets The offset values associated with the output buffer. + * @param string_indices Start of index iterator. + * @param total_out_strings Number of output strings to be gathered. */ template __global__ void gather_chars_fn_string_parallel(StringIterator strings_begin, @@ -153,11 +153,11 @@ __global__ void gather_chars_fn_string_parallel(StringIterator strings_begin, * @tparam StringIterator Iterator should produce `string_view` objects. * @tparam MapIterator Iterator for retrieving integer indices of the `StringIterator`. * - * @param strings_begin Start of the iterator to retrieve `string_view` instances - * @param out_chars Output buffer for gathered characters - * @param out_offsets The offset values associated with the output buffer - * @param string_indices Start of index iterator - * @param total_out_strings Number of output strings to be gathered + * @param strings_begin Start of the iterator to retrieve `string_view` instances. + * @param out_chars Output buffer for gathered characters. + * @param out_offsets The offset values associated with the output buffer. + * @param string_indices Start of index iterator. + * @param total_out_strings Number of output strings to be gathered. */ template __global__ void gather_chars_fn_char_parallel(StringIterator strings_begin, @@ -212,13 +212,13 @@ __global__ void gather_chars_fn_char_parallel(StringIterator strings_begin, * @tparam StringIterator Iterator should produce `string_view` objects. * @tparam MapIterator Iterator for retrieving integer indices of the `StringIterator`. * - * @param strings_begin Start of the iterator to retrieve `string_view` instances - * @param map_begin Start of index iterator - * @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 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 + * @param strings_begin Start of the iterator to retrieve `string_view` instances. + * @param map_begin Start of index iterator. + * @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 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 @@ -279,11 +279,11 @@ std::unique_ptr gather_chars(StringIterator strings_begin, * @tparam NullifyOutOfBounds If true, indices outside the column's range are nullified. * @tparam MapIterator Iterator for retrieving integer indices of the column. * - * @param strings Strings instance for this operation - * @param begin Start of index iterator - * @param end End of index iterator - * @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 + * @param strings Strings instance for this operation. + * @param begin Start of index iterator. + * @param end End of index iterator. + * @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 @@ -362,12 +362,12 @@ std::unique_ptr gather( * * @tparam MapIterator Iterator for retrieving integer indices of the column. * - * @param strings Strings instance for this operation - * @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 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 + * @param strings Strings instance for this operation. + * @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 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 68a016dd63a..207c9e9cd9f 100644 --- a/cpp/include/cudf/strings/detail/merge.cuh +++ b/cpp/include/cudf/strings/detail/merge.cuh @@ -41,11 +41,11 @@ namespace detail { * * @tparam row_order_iterator This must be an iterator for type thrust::tuple. * - * @param lhs First column - * @param rhs Second column - * @param row_order Indexes for each column - * @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 + * @param lhs First column. + * @param rhs Second column. + * @param row_order Indexes for each column. + * @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/replace.hpp b/cpp/include/cudf/strings/detail/replace.hpp index 0243e99915c..820168ce3de 100644 --- a/cpp/include/cudf/strings/detail/replace.hpp +++ b/cpp/include/cudf/strings/detail/replace.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2022, NVIDIA CORPORATION. + * Copyright (c) 2020-2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,7 +39,7 @@ enum class replace_algorithm { * string_scalar const&, int32_t, rmm::mr::device_memory_resource*) * * @tparam alg Replacement algorithm to use - * @param[in] stream CUDA stream used for device memory operations and kernel launches + * @param[in] stream CUDA stream used for device memory operations and kernel launches. */ template std::unique_ptr replace( @@ -54,7 +54,7 @@ std::unique_ptr replace( * @copydoc cudf::strings::replace_slice(strings_column_view const&, string_scalar const&, * size_type. size_type, rmm::mr::device_memory_resource*) * - * @param[in] stream CUDA stream used for device memory operations and kernel launches + * @param[in] stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr replace_slice( strings_column_view const& strings, @@ -68,7 +68,7 @@ std::unique_ptr replace_slice( * @copydoc cudf::strings::replace(strings_column_view const&, strings_column_view const&, * strings_column_view const&, rmm::mr::device_memory_resource*) * - * @param[in] stream CUDA stream used for device memory operations and kernel launches + * @param[in] stream CUDA stream used for device memory operations and kernel launches. */ std::unique_ptr replace( strings_column_view const& strings, @@ -89,10 +89,10 @@ std::unique_ptr replace( * r is now ["hello", "**", "goodbye"] * @endcode * - * @param strings Strings column for this operation - * @param repl Replacement string for null entries. Default is empty string - * @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 + * @param strings Strings column for this operation. + * @param repl Replacement string for null entries. Default is empty string. + * @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 replace_nulls( diff --git a/cpp/include/cudf/strings/detail/scatter.cuh b/cpp/include/cudf/strings/detail/scatter.cuh index cbaaec0c1b6..cfede60c771 100644 --- a/cpp/include/cudf/strings/detail/scatter.cuh +++ b/cpp/include/cudf/strings/detail/scatter.cuh @@ -45,11 +45,11 @@ namespace detail { * @tparam SourceIterator must produce string_view objects * @tparam MapIterator must produce index values within the target column. * - * @param source The iterator of source strings to scatter into the output column - * @param scatter_map Iterator of indices into the output column + * @param source The iterator of source strings to scatter into the output column. + * @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 stream CUDA stream used for device memory operations and kernel launches + * @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. */ diff --git a/cpp/include/cudf/strings/detail/utf8.hpp b/cpp/include/cudf/strings/detail/utf8.hpp index 520ad3bdb3f..1b88a9dd8fd 100644 --- a/cpp/include/cudf/strings/detail/utf8.hpp +++ b/cpp/include/cudf/strings/detail/utf8.hpp @@ -61,7 +61,7 @@ constexpr size_type bytes_in_char_utf8(char_utf8 character) * single character. For example, for the two-byte 0xC3A8 single character, * the first byte would return 2 and the second byte would return 0. * - * @param byte Byte from an encoded character + * @param byte Byte from an encoded character. * @return Number of bytes. */ constexpr size_type bytes_in_utf8_byte(uint8_t byte) @@ -75,8 +75,8 @@ constexpr size_type bytes_in_utf8_byte(uint8_t byte) /** * @brief Convert a char array into a char_utf8 value. * - * @param str String containing encoded char bytes - * @param[out] character Single char_utf8 value + * @param str String containing encoded char bytes. + * @param[out] character Single char_utf8 value. * @return The number of bytes in the character */ constexpr size_type to_char_utf8(const char* str, char_utf8& character) @@ -103,7 +103,7 @@ constexpr size_type to_char_utf8(const char* str, char_utf8& character) * @brief Place a char_utf8 value into a char array. * * @param character Single character - * @param[out] str Output array + * @param[out] str Output array. * @return The number of bytes in the character */ constexpr inline size_type from_char_utf8(char_utf8 character, char* str) diff --git a/cpp/include/cudf/strings/detail/utilities.cuh b/cpp/include/cudf/strings/detail/utilities.cuh index 82cf82a71ee..76a0ce721c0 100644 --- a/cpp/include/cudf/strings/detail/utilities.cuh +++ b/cpp/include/cudf/strings/detail/utilities.cuh @@ -44,8 +44,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 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 + * @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 @@ -75,9 +75,9 @@ std::unique_ptr make_offsets_child_column( * @brief Copies input string data into a buffer and increments the pointer by the number of bytes * copied. * - * @param buffer Device buffer to copy to - * @param input Data to copy from - * @param bytes Number of bytes to copy + * @param buffer Device buffer to copy to. + * @param input Data to copy from. + * @param bytes Number of bytes to copy. * @return Pointer to the end of the output buffer after the copy. */ __device__ inline char* copy_and_increment(char* buffer, const char* input, size_type bytes) @@ -90,8 +90,8 @@ __device__ inline char* copy_and_increment(char* buffer, const char* input, size * @brief Copies input string data into a buffer and increments the pointer by the number of bytes * copied. * - * @param buffer Device buffer to copy to - * @param d_string String to copy + * @param buffer Device buffer to copy to. + * @param d_string String to copy. * @return Pointer to the end of the output buffer after the copy. */ __device__ inline char* copy_string(char* buffer, const string_view& d_string) @@ -109,10 +109,10 @@ __device__ inline char* copy_string(char* buffer, const string_view& d_string) * * @param size_and_exec_fn This is called twice. Once for the output size of each string * and once again to fill in the memory pointed to by d_chars. - * @param exec_size Number of rows for executing the `size_and_exec_fn` function - * @param strings_count Number of strings - * @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 + * @param exec_size Number of rows for executing the `size_and_exec_fn` function. + * @param strings_count Number of strings. + * @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 @@ -168,9 +168,9 @@ auto make_strings_children( * * @param size_and_exec_fn This is called twice. Once for the output size of each string * and once again to fill in the memory pointed to by d_chars. - * @param strings_count Number of strings - * @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 + * @param strings_count Number of strings. + * @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/cudf/strings/detail/utilities.hpp b/cpp/include/cudf/strings/detail/utilities.hpp index faa3ccd7a45..c4f9e547148 100644 --- a/cpp/include/cudf/strings/detail/utilities.hpp +++ b/cpp/include/cudf/strings/detail/utilities.hpp @@ -30,9 +30,9 @@ namespace detail { * * This will return the properly sized column to be filled in by the caller. * - * @param bytes Number of bytes for the chars column - * @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 + * @param bytes Number of bytes for the chars column. + * @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 The chars child column for a strings column. */ std::unique_ptr create_chars_child_column( @@ -43,9 +43,9 @@ std::unique_ptr create_chars_child_column( /** * @brief Creates a string_view vector from a strings column. * - * @param strings Strings column instance - * @param stream CUDA stream used for device memory operations and kernel launches - * @param mr Device memory resource used to allocate the returned vector's device memory + * @param strings Strings column instance. + * @param stream CUDA stream used for device memory operations and kernel launches. + * @param mr Device memory resource used to allocate the returned vector's device memory. * @return Device vector of string_views */ rmm::device_uvector create_string_vector_from_column( diff --git a/cpp/include/cudf/strings/extract.hpp b/cpp/include/cudf/strings/extract.hpp index 13653ccf795..680d0f5b7bc 100644 --- a/cpp/include/cudf/strings/extract.hpp +++ b/cpp/include/cudf/strings/extract.hpp @@ -47,10 +47,10 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param pattern The regular expression pattern with group indicators - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned table's device memory + * @param strings Strings instance for this operation. + * @param pattern The regular expression pattern with group indicators. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned table's device memory. * @return Columns of strings extracted from the input column. */ std::unique_ptr
extract( @@ -82,10 +82,10 @@ std::unique_ptr
extract( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param pattern The regular expression pattern with group indicators - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate any returned device memory + * @param strings Strings instance for this operation. + * @param pattern The regular expression pattern with group indicators. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate any returned device memory. * @return Lists column containing strings extracted from the input column. */ std::unique_ptr extract_all_record( diff --git a/cpp/include/cudf/strings/find.hpp b/cpp/include/cudf/strings/find.hpp index ff8e8fac5ca..fee1ea2dae4 100644 --- a/cpp/include/cudf/strings/find.hpp +++ b/cpp/include/cudf/strings/find.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -41,12 +41,12 @@ namespace strings { * * @throw cudf::logic_error if start position is greater than stop position. * - * @param strings Strings instance for this operation - * @param target UTF-8 encoded string to search for in each string - * @param start First character position to include in the search - * @param stop Last position (exclusive) to include in the search; + * @param strings Strings instance for this operation. + * @param target UTF-8 encoded string to search for in each string. + * @param start First character position to include in the search. + * @param stop Last position (exclusive) to include in the search. * Default of -1 will search to the end of the string. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New integer column with character position values. */ std::unique_ptr find( @@ -70,12 +70,12 @@ std::unique_ptr find( * * @throw cudf::logic_error if start position is greater than stop position. * - * @param strings Strings instance for this operation - * @param target UTF-8 encoded string to search for in each string - * @param start First position to include in the search - * @param stop Last position (exclusive) to include in the search; + * @param strings Strings instance for this operation. + * @param target UTF-8 encoded string to search for in each string. + * @param start First position to include in the search. + * @param stop Last position (exclusive) to include in the search. * Default of -1 will search starting at the end of the string. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New integer column with character position values. */ std::unique_ptr rfind( @@ -94,9 +94,9 @@ std::unique_ptr rfind( * * Any null string entries return corresponding null entries in the output columns. * - * @param strings Strings instance for this operation - * @param target UTF-8 encoded string to search for in each string - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param target UTF-8 encoded string to search for in each string. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New type_id::BOOL8 column. */ std::unique_ptr contains( @@ -117,9 +117,9 @@ std::unique_ptr contains( * * @throw cudf::logic_error if `strings.size() != targets.size()`. * - * @param strings Strings instance for this operation - * @param targets Strings column of targets to check row-wise in `strings` - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param targets Strings column of targets to check row-wise in `strings`. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New type_id::BOOL8 column. */ std::unique_ptr contains( @@ -137,9 +137,9 @@ std::unique_ptr contains( * * Any null string entries return corresponding null entries in the output columns. * - * @param strings Strings instance for this operation - * @param target UTF-8 encoded string to search for in each string - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param target UTF-8 encoded string to search for in each string. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New type_id::BOOL8 column. */ std::unique_ptr starts_with( @@ -161,9 +161,9 @@ std::unique_ptr starts_with( * * @throw cudf::logic_error if `strings.size() != targets.size()`. * - * @param strings Strings instance for this operation - * @param targets Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param targets Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New type_id::BOOL8 column. */ std::unique_ptr starts_with( @@ -181,9 +181,9 @@ std::unique_ptr starts_with( * * Any null string entries return corresponding null entries in the output columns. * - * @param strings Strings instance for this operation - * @param target UTF-8 encoded string to search for in each string - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param target UTF-8 encoded string to search for in each string. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New type_id::BOOL8 column. */ std::unique_ptr ends_with( @@ -205,9 +205,9 @@ std::unique_ptr ends_with( * * @throw cudf::logic_error if `strings.size() != targets.size()`. * - * @param strings Strings instance for this operation - * @param targets Strings instance for this operation - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param targets Strings instance for this operation. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New type_id::BOOL8 column. */ std::unique_ptr ends_with( diff --git a/cpp/include/cudf/strings/find_multiple.hpp b/cpp/include/cudf/strings/find_multiple.hpp index b92ebaa1c8d..0964e713592 100644 --- a/cpp/include/cudf/strings/find_multiple.hpp +++ b/cpp/include/cudf/strings/find_multiple.hpp @@ -46,9 +46,9 @@ namespace strings { * * @throw cudf::logic_error if `targets` is empty or contains nulls * - * @param input Strings instance for this operation - * @param targets Strings to search for in each string - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Strings instance for this operation. + * @param targets Strings to search for in each string. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return Lists column with character position values. */ std::unique_ptr find_multiple( diff --git a/cpp/include/cudf/strings/findall.hpp b/cpp/include/cudf/strings/findall.hpp index bcee5b564c9..25c6d523250 100644 --- a/cpp/include/cudf/strings/findall.hpp +++ b/cpp/include/cudf/strings/findall.hpp @@ -48,10 +48,10 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param input Strings instance for this operation - * @param pattern Regex pattern to match within each string - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned table's device memory + * @param input Strings instance for this operation. + * @param pattern Regex pattern to match within each string. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned table's device memory. * @return New table of strings columns. */ std::unique_ptr
findall( @@ -82,10 +82,10 @@ std::unique_ptr
findall( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param input Strings instance for this operation - * @param pattern Regex pattern to match within each string - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned column's device memory + * @param input Strings instance for this operation. + * @param pattern Regex pattern to match within each string. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New lists column of strings. */ std::unique_ptr findall_record( diff --git a/cpp/include/cudf/strings/json.hpp b/cpp/include/cudf/strings/json.hpp index 8843b5df157..2b66bcb807e 100644 --- a/cpp/include/cudf/strings/json.hpp +++ b/cpp/include/cudf/strings/json.hpp @@ -87,7 +87,7 @@ class get_json_object_options { /** * @brief Set whether single-quotes for strings are allowed. * - * @param _allow_single_quotes bool indicating desired behavior + * @param _allow_single_quotes bool indicating desired behavior. */ void set_allow_single_quotes(bool _allow_single_quotes) { @@ -97,7 +97,7 @@ class get_json_object_options { /** * @brief Set whether individually returned string values have their quotes stripped. * - * @param _strip_quotes_from_single_strings bool indicating desired behavior + * @param _strip_quotes_from_single_strings bool indicating desired behavior. */ void set_strip_quotes_from_single_strings(bool _strip_quotes_from_single_strings) { @@ -114,10 +114,10 @@ class get_json_object_options { * https://tools.ietf.org/id/draft-goessner-dispatch-jsonpath-00.html * Implements only the operators: $ . [] * * - * @param col The input strings column Each row must contain a valid json string + * @param col The input strings column. Each row must contain a valid json string * @param json_path The JSONPath string to be applied to each row * @param options Options for controlling the behavior of the function - * @param mr Resource for allocating device memory + * @param mr Resource for allocating device memory. * @return New strings column containing the retrieved json object strings */ std::unique_ptr get_json_object( diff --git a/cpp/include/cudf/strings/padding.hpp b/cpp/include/cudf/strings/padding.hpp index 0f270ac9b00..754e828fae0 100644 --- a/cpp/include/cudf/strings/padding.hpp +++ b/cpp/include/cudf/strings/padding.hpp @@ -52,13 +52,13 @@ enum class pad_side { * r is now ['aa ','bbb ','cccc','ddddd'] * @endcode * - * @param strings Strings instance for this operation - * @param width The minimum number of characters for each string - * @param side Where to place the padding characters; + * @param strings Strings instance for this operation. + * @param width The minimum number of characters for each string. + * @param side Where to place the padding characters. * Default is pad right (left justify). - * @param fill_char Single UTF-8 character to use for padding; + * @param fill_char Single UTF-8 character to use for padding. * Default is the space character. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with padded strings. */ std::unique_ptr pad( @@ -85,9 +85,9 @@ std::unique_ptr pad( * r is now ['001234','0-9876','0+0.34','-342567'] * @endcode * - * @param strings Strings instance for this operation - * @param width The minimum number of characters for each string - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param width The minimum number of characters for each string. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column of strings. */ std::unique_ptr zfill( diff --git a/cpp/include/cudf/strings/repeat_strings.hpp b/cpp/include/cudf/strings/repeat_strings.hpp index f7366efd512..f6bf12af967 100644 --- a/cpp/include/cudf/strings/repeat_strings.hpp +++ b/cpp/include/cudf/strings/repeat_strings.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2022, NVIDIA CORPORATION. + * Copyright (c) 2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,9 +51,9 @@ namespace strings { * can be stored by the index type * (i.e., @code input.size() * repeat_times > numeric_limits::max() @endcode). * - * @param input The scalar containing the string to repeat - * @param repeat_times The number of times the input string is repeated - * @param mr Device memory resource used to allocate the returned string scalar + * @param input The scalar containing the string to repeat. + * @param repeat_times The number of times the input string is repeated. + * @param mr Device memory resource used to allocate the returned string scalar. * @return New string scalar in which the input string is repeated. */ std::unique_ptr repeat_string( @@ -83,9 +83,9 @@ std::unique_ptr repeat_string( * out is ['aaaaaa', null, '', 'bbcbbcbbc'] * @endcode * - * @param input The column containing strings to repeat - * @param repeat_times The number of times each input string is repeated - * @param mr Device memory resource used to allocate the returned strings column + * @param input The column containing strings to repeat. + * @param repeat_times The number of times each input string is repeated. + * @param mr Device memory resource used to allocate the returned strings column. * @return New column containing the repeated strings. */ std::unique_ptr repeat_strings( @@ -121,12 +121,12 @@ std::unique_ptr repeat_strings( * @throw cudf::logic_error if the input `repeat_times` column has data type other than integer. * @throw cudf::logic_error if the input columns have different sizes. * - * @param input The column containing strings to repeat + * @param input The column containing strings to repeat. * @param repeat_times The column containing numbers of times that the corresponding input strings * are repeated. * @param output_strings_sizes The optional column containing pre-computed sizes of the output * strings. - * @param mr Device memory resource used to allocate the returned strings column + * @param mr Device memory resource used to allocate the returned strings column. * @return New column containing the repeated strings. */ std::unique_ptr repeat_strings( @@ -154,10 +154,10 @@ std::unique_ptr repeat_strings( * @throw cudf::logic_error if the input `repeat_times` column has data type other than integer. * @throw cudf::logic_error if the input columns have different sizes. * - * @param input The column containing strings to repeat + * @param input The column containing strings to repeat. * @param repeat_times The column containing numbers of times that the corresponding input strings * are repeated. - * @param mr Device memory resource used to allocate the returned strings column + * @param mr Device memory resource used to allocate the returned strings column. * @return A pair with the first item is an int32_t column containing sizes of the output strings, * and the second item is an int64_t number containing the total sizes (in bytes) of the * output strings column. diff --git a/cpp/include/cudf/strings/replace.hpp b/cpp/include/cudf/strings/replace.hpp index 8fd307ebf1e..40eb796eba7 100644 --- a/cpp/include/cudf/strings/replace.hpp +++ b/cpp/include/cudf/strings/replace.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -52,12 +52,12 @@ namespace strings { * * @throw cudf::logic_error if target is an empty string. * - * @param strings Strings column for this operation - * @param target String to search for within each string - * @param repl Replacement string if target is found - * @param maxrepl Maximum times to replace if target appears multiple times in the input string; + * @param strings Strings column for this operation. + * @param target String to search for within each string. + * @param repl Replacement string if target is found. + * @param maxrepl Maximum times to replace if target appears multiple times in the input string. * Default of -1 specifies replace all occurrences of target in each string. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr replace( @@ -90,14 +90,14 @@ std::unique_ptr replace( * * @throw cudf::logic_error if start is greater than stop. * - * @param strings Strings column for this operation - * @param repl Replacement string for specified positions found; + * @param strings Strings column for this operation. + * @param repl Replacement string for specified positions found. * Default is empty string. - * @param start Start position where repl will be added; + * @param start Start position where repl will be added. * Default is 0, first character position. - * @param stop End position (exclusive) to use for replacement; + * @param stop End position (exclusive) to use for replacement. * Default of -1 specifies the end of each string. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr replace_slice( @@ -139,10 +139,10 @@ std::unique_ptr replace_slice( * if repls is a single string. * @throw cudf::logic_error if targets or repls contain null entries. * - * @param strings Strings column for this operation - * @param targets Strings to search for in each string - * @param repls Corresponding replacement strings for target strings - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings column for this operation. + * @param targets Strings to search for in each string. + * @param repls Corresponding replacement strings for target strings. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr replace( diff --git a/cpp/include/cudf/strings/replace_re.hpp b/cpp/include/cudf/strings/replace_re.hpp index b2bfe47137b..36c287009d0 100644 --- a/cpp/include/cudf/strings/replace_re.hpp +++ b/cpp/include/cudf/strings/replace_re.hpp @@ -38,14 +38,14 @@ namespace strings { * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param pattern The regular expression pattern to search within each string - * @param replacement The string used to replace the matched sequence in each string; + * @param strings Strings instance for this operation. + * @param pattern The regular expression pattern to search within each string. + * @param replacement The string used to replace the matched sequence in each string. * Default is an empty string. * @param max_replace_count The maximum number of times to replace the matched pattern * within each string. Default replaces every substring that is matched. - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned column's device memory + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr replace_re( @@ -64,11 +64,11 @@ std::unique_ptr replace_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param strings Strings instance for this operation - * @param patterns The regular expression patterns to search within each string - * @param replacements The strings used for replacement - * @param flags Regex flags for interpreting special characters in the patterns - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param patterns The regular expression patterns to search within each string. + * @param replacements The strings used for replacement. + * @param flags Regex flags for interpreting special characters in the patterns. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr replace_re( @@ -89,11 +89,11 @@ std::unique_ptr replace_re( * @throw cudf::logic_error if capture index values in `replacement` are not in range 0-99, and also * if the index exceeds the group count specified in the pattern * - * @param strings Strings instance for this operation - * @param pattern The regular expression patterns to search within each string - * @param replacement The replacement template for creating the output string - * @param flags Regex flags for interpreting special characters in the pattern - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param pattern The regular expression patterns to search within each string. + * @param replacement The replacement template for creating the output string. + * @param flags Regex flags for interpreting special characters in the pattern. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr replace_with_backrefs( diff --git a/cpp/include/cudf/strings/split/partition.hpp b/cpp/include/cudf/strings/split/partition.hpp index b7bc1b49bfe..305726a1f21 100644 --- a/cpp/include/cudf/strings/split/partition.hpp +++ b/cpp/include/cudf/strings/split/partition.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -49,10 +49,10 @@ namespace strings { * r[2] is ["cd","g_h"] * @endcode * - * @param strings Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating where to split each string; + * @param strings Strings instance for this operation. + * @param delimiter UTF-8 encoded string indicating where to split each string. * Default of empty string indicates split on whitespace. - * @param mr Device memory resource used to allocate the returned table's device memory + * @param mr Device memory resource used to allocate the returned table's device memory. * @return New table of strings columns. */ std::unique_ptr
partition( @@ -81,10 +81,10 @@ std::unique_ptr
partition( * r[2] is ["cd","h"] * @endcode * - * @param strings Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating where to split each string; + * @param strings Strings instance for this operation. + * @param delimiter UTF-8 encoded string indicating where to split each string. * Default of empty string indicates split on whitespace. - * @param mr Device memory resource used to allocate the returned table's device memory + * @param mr Device memory resource used to allocate the returned table's device memory. * @return New strings columns. */ std::unique_ptr
rpartition( diff --git a/cpp/include/cudf/strings/split/split.hpp b/cpp/include/cudf/strings/split/split.hpp index 6b3e72dd738..4978bad3bb3 100644 --- a/cpp/include/cudf/strings/split/split.hpp +++ b/cpp/include/cudf/strings/split/split.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2020, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -41,12 +41,12 @@ namespace strings { * * Any null string entries return corresponding null output columns. * - * @param strings_column Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating the split points in each string; + * @param strings_column Strings instance for this operation. + * @param delimiter UTF-8 encoded string indicating the split points in each string. * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform; + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned table's device memory + * @param mr Device memory resource used to allocate the returned table's device memory. * @return New table of strings columns. */ std::unique_ptr
split( @@ -69,12 +69,12 @@ std::unique_ptr
split( * * Any null string entries return corresponding null output columns. * - * @param strings_column Strings instance for this operation - * @param delimiter UTF-8 encoded string indicating the split points in each string; + * @param strings_column Strings instance for this operation. + * @param delimiter UTF-8 encoded string indicating the split points in each string. * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform; + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned table's device memory + * @param mr Device memory resource used to allocate the returned table's device memory. * @return New strings columns. */ std::unique_ptr
rsplit( @@ -139,12 +139,12 @@ std::unique_ptr
rsplit( * * @throw cudf:logic_error if `delimiter` is invalid. * - * @param strings A column of string elements to be split - * @param delimiter The string to identify split points in each string + * @param strings A column of string elements to be split. + * @param delimiter The string to identify split points in each string. * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory + * @param mr Device memory resource used to allocate the returned result's device memory. * @return Lists column of strings * Each vector of the lists column holds splits from a single row * element of the input column. @@ -216,12 +216,12 @@ std::unique_ptr split_record( * * @throw cudf:logic_error if `delimiter` is invalid. * - * @param strings A column of string elements to be split - * @param delimiter The string to identify split points in each string; + * @param strings A column of string elements to be split. + * @param delimiter The string to identify split points in each string. * Default of empty string indicates split on whitespace. - * @param maxsplit Maximum number of splits to perform; + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory + * @param mr Device memory resource used to allocate the returned result's device memory. * @return Lists column of strings * Each vector of the lists column holds splits from a single row * element of the input column. diff --git a/cpp/include/cudf/strings/split/split_re.hpp b/cpp/include/cudf/strings/split/split_re.hpp index 6cd5236a779..57246bd91d2 100644 --- a/cpp/include/cudf/strings/split/split_re.hpp +++ b/cpp/include/cudf/strings/split/split_re.hpp @@ -62,11 +62,11 @@ namespace strings { * * @throw cudf::logic_error if `pattern` is empty. * - * @param input A column of string elements to be split - * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform; + * @param input A column of string elements to be split. + * @param pattern The regex pattern for delimiting characters within each string. + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory + * @param mr Device memory resource used to allocate the returned result's device memory. * @return A table of columns of strings. */ std::unique_ptr
split_re( @@ -112,11 +112,11 @@ std::unique_ptr
split_re( * * @throw cudf::logic_error if `pattern` is empty. * - * @param input A column of string elements to be split - * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform; + * @param input A column of string elements to be split. + * @param pattern The regex pattern for delimiting characters within each string. + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory + * @param mr Device memory resource used to allocate the returned result's device memory. * @return A table of columns of strings. */ std::unique_ptr
rsplit_re( @@ -164,11 +164,11 @@ std::unique_ptr
rsplit_re( * * See the @ref md_regex "Regex Features" page for details on patterns supported by this API. * - * @param input A column of string elements to be split - * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform; + * @param input A column of string elements to be split. + * @param pattern The regex pattern for delimiting characters within each string. + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory + * @param mr Device memory resource used to allocate the returned result's device memory. * @return Lists column of strings. */ std::unique_ptr split_record_re( @@ -218,11 +218,11 @@ std::unique_ptr split_record_re( * * @throw cudf::logic_error if `pattern` is empty. * - * @param input A column of string elements to be split - * @param pattern The regex pattern for delimiting characters within each string - * @param maxsplit Maximum number of splits to perform; + * @param input A column of string elements to be split. + * @param pattern The regex pattern for delimiting characters within each string. + * @param maxsplit Maximum number of splits to perform. * Default of -1 indicates all possible splits on each string. - * @param mr Device memory resource used to allocate the returned result's device memory + * @param mr Device memory resource used to allocate the returned result's device memory. * @return Lists column of strings. */ std::unique_ptr rsplit_record_re( diff --git a/cpp/include/cudf/strings/string.cuh b/cpp/include/cudf/strings/string.cuh index 24c3bb9fb02..d20080cc0e5 100644 --- a/cpp/include/cudf/strings/string.cuh +++ b/cpp/include/cudf/strings/string.cuh @@ -40,7 +40,7 @@ namespace strings { * No bounds checking is performed to verify if the integer will fit * within a specific integer type. * - * @param d_str String to check + * @param d_str String to check. * @return true if string has valid integer characters */ inline __device__ bool is_integer(string_view const& d_str) @@ -107,7 +107,7 @@ inline __device__ bool is_inf_str(string_view const& d_str) * The following strings are also allowed and will return true: * "NaN", "NAN", "Inf", "INF", "INFINITY" * - * @param d_str String to check + * @param d_str String to check. * @return true if string has valid float characters */ inline __device__ bool is_float(string_view const& d_str) diff --git a/cpp/include/cudf/strings/string_view.cuh b/cpp/include/cudf/strings/string_view.cuh index 21f4ab96110..57d082cf11c 100644 --- a/cpp/include/cudf/strings/string_view.cuh +++ b/cpp/include/cudf/strings/string_view.cuh @@ -40,8 +40,8 @@ namespace detail { /** * @brief Return the number of UTF-8 characters in this provided char array. * - * @param str String with encoded char bytes - * @param bytes Number of bytes in str + * @param str String with encoded char bytes. + * @param bytes Number of bytes in str. * @return The number of characters in the array. */ __device__ inline size_type characters_in_string(const char* str, size_type bytes) diff --git a/cpp/include/cudf/strings/string_view.hpp b/cpp/include/cudf/strings/string_view.hpp index 22c99b2640c..fbe2253bf25 100644 --- a/cpp/include/cudf/strings/string_view.hpp +++ b/cpp/include/cudf/strings/string_view.hpp @@ -148,7 +148,7 @@ class string_view { * @brief Comparing target string with this string. Each character is compared * as a UTF-8 code-point value. * - * @param str Target string to compare with this string + * @param str Target string to compare with this string. * @return 0 If they compare equal. * <0 Either the value of the first character of this string that does * not match is lower in the arg string, or all compared characters @@ -162,8 +162,8 @@ class string_view { * @brief Comparing target string with this string. Each character is compared * as a UTF-8 code-point value. * - * @param str Target string to compare with this string - * @param bytes Number of bytes in str + * @param str Target string to compare with this string. + * @param bytes Number of bytes in str. * @return 0 If they compare equal. * <0 Either the value of the first character of this string that does * not match is lower in the arg string, or all compared characters @@ -177,42 +177,42 @@ class string_view { /** * @brief Returns true if rhs matches this string exactly. * - * @param rhs Target string to compare with this string + * @param rhs Target string to compare with this string. * @return true if rhs matches this string exactly */ __device__ inline bool operator==(const string_view& rhs) const; /** * @brief Returns true if rhs does not match this string. * - * @param rhs Target string to compare with this string + * @param rhs Target string to compare with this string. * @return true if rhs does not match this string */ __device__ inline bool operator!=(const string_view& rhs) const; /** * @brief Returns true if this string is ordered before rhs. * - * @param rhs Target string to compare with this string + * @param rhs Target string to compare with this string. * @return true if this string is ordered before rhs */ __device__ inline bool operator<(const string_view& rhs) const; /** * @brief Returns true if rhs is ordered before this string. * - * @param rhs Target string to compare with this string + * @param rhs Target string to compare with this string. * @return true if rhs is ordered before this string */ __device__ inline bool operator>(const string_view& rhs) const; /** * @brief Returns true if this string matches or is ordered before rhs. * - * @param rhs Target string to compare with this string + * @param rhs Target string to compare with this string. * @return true if this string matches or is ordered before rhs */ __device__ inline bool operator<=(const string_view& rhs) const; /** * @brief Returns true if rhs matches or is ordered before this string. * - * @param rhs Target string to compare with this string + * @param rhs Target string to compare with this string. * @return true if rhs matches or is ordered before this string */ __device__ inline bool operator>=(const string_view& rhs) const; @@ -221,9 +221,9 @@ class string_view { * @brief Returns the character position of the first occurrence where the * argument str is found in this string within the character range [pos,pos+n). * - * @param str Target string to search within this string - * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search; + * @param str Target string to search within this string. + * @param pos Character position to start search within this string. + * @param count Number of characters from pos to include in the search. * Specify -1 to indicate to the end of the string. * @return -1 if str is not found in this string. */ @@ -234,10 +234,10 @@ class string_view { * @brief Returns the character position of the first occurrence where the * array str is found in this string within the character range [pos,pos+n). * - * @param str Target array to search within this string - * @param bytes Number of bytes in str - * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search; + * @param str Target array to search within this string. + * @param bytes Number of bytes in str. + * @param pos Character position to start search within this string. + * @param count Number of characters from pos to include in the search. * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -249,9 +249,9 @@ class string_view { * @brief Returns the character position of the first occurrence where * character is found in this string within the character range [pos,pos+n). * - * @param character Single encoded character - * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search; + * @param character Single encoded character. + * @param pos Character position to start search within this string. + * @param count Number of characters from pos to include in the search. * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -262,9 +262,9 @@ class string_view { * @brief Returns the character position of the last occurrence where the * argument str is found in this string within the character range [pos,pos+n). * - * @param str Target string to search within this string - * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search; + * @param str Target string to search within this string. + * @param pos Character position to start search within this string. + * @param count Number of characters from pos to include in the search. * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -275,10 +275,10 @@ class string_view { * @brief Returns the character position of the last occurrence where the * array str is found in this string within the character range [pos,pos+n). * - * @param str Target string to search with this string - * @param bytes Number of bytes in str - * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search; + * @param str Target string to search with this string. + * @param bytes Number of bytes in str. + * @param pos Character position to start search within this string. + * @param count Number of characters from pos to include in the search. * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -290,9 +290,9 @@ class string_view { * @brief Returns the character position of the last occurrence where * character is found in this string within the character range [pos,pos+n). * - * @param character Single encoded character - * @param pos Character position to start search within this string - * @param count Number of characters from pos to include in the search; + * @param character Single encoded character. + * @param pos Character position to start search within this string. + * @param count Number of characters from pos to include in the search. * Specify -1 to indicate to the end of the string. * @return -1 if arg string is not found in this string. */ @@ -304,8 +304,8 @@ class string_view { * @brief Return a sub-string of this string. The original string and device * memory must still be maintained for the lifetime of the returned instance. * - * @param start Character position to start the sub-string - * @param length Number of characters from start to include in the sub-string + * @param start Character position to start the sub-string. + * @param length Number of characters from start to include in the sub-string. * @return New instance pointing to a subset of the characters within this instance. */ __device__ [[nodiscard]] inline string_view substr(size_type start, size_type length) const; @@ -339,8 +339,8 @@ class string_view { /** * @brief Create instance from existing device char array. * - * @param data Device char array encoded in UTF8 - * @param bytes Number of bytes in data array + * @param data Device char array encoded in UTF8. + * @param bytes Number of bytes in data array. */ CUDF_HOST_DEVICE inline string_view(const char* data, size_type bytes) : _data(data), _bytes(bytes), _length(UNKNOWN_STRING_LENGTH) @@ -371,7 +371,7 @@ class string_view { /** * @brief Return the character position of the given byte offset. * - * @param bytepos Byte position from start of _data + * @param bytepos Byte position from start of _data. * @return The character position for the specified byte. */ __device__ [[nodiscard]] inline size_type character_offset(size_type bytepos) const; diff --git a/cpp/include/cudf/strings/strings_column_view.hpp b/cpp/include/cudf/strings/strings_column_view.hpp index efc70bab704..e617dbde024 100644 --- a/cpp/include/cudf/strings/strings_column_view.hpp +++ b/cpp/include/cudf/strings/strings_column_view.hpp @@ -36,9 +36,9 @@ namespace cudf { class strings_column_view : private column_view { public: /** - * @brief Construct a new strings_column_view object from a column_view + * @brief Construct a new strings column view object from a column view.s * - * @param strings_column The column_view to wrap + * @param strings_column The column view to wrap. */ strings_column_view(column_view strings_column); strings_column_view(strings_column_view&&) = default; ///< Move constructor diff --git a/cpp/include/cudf/strings/strip.hpp b/cpp/include/cudf/strings/strip.hpp index 13876dd7c5d..fe9cd41e780 100644 --- a/cpp/include/cudf/strings/strip.hpp +++ b/cpp/include/cudf/strings/strip.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -58,12 +58,12 @@ enum class strip_type { * * @throw cudf::logic_error if `to_strip` is invalid. * - * @param strings Strings column for this operation + * @param strings Strings column for this operation. * @param stype Indicates characters are to be stripped from the beginning, end, or both of each * string. Default is both. - * @param to_strip UTF-8 encoded characters to strip from each string + * @param to_strip UTF-8 encoded characters to strip from each string. * Default is empty string which indicates strip whitespace characters. - * @param mr Device memory resource used to allocate the returned column's device memory + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column. */ std::unique_ptr strip( diff --git a/cpp/include/cudf/strings/substring.hpp b/cpp/include/cudf/strings/substring.hpp index ae76e390210..645b0cead3f 100644 --- a/cpp/include/cudf/strings/substring.hpp +++ b/cpp/include/cudf/strings/substring.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2020, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -48,11 +48,11 @@ namespace strings { * r2 is now ["lo","ob"] * @endcode * - * @param strings Strings column for this operation - * @param start First character position to begin the substring - * @param stop Last character position (exclusive) to end the substring - * @param step Distance between input characters retrieved - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings column for this operation. + * @param start First character position to begin the substring. + * @param stop Last character position (exclusive) to end the substring. + * @param step Distance between input characters retrieved. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with sorted elements of this instance. */ std::unique_ptr slice_strings( @@ -93,10 +93,10 @@ std::unique_ptr slice_strings( * @throw cudf::logic_error if starts and stops are not same integer type. * @throw cudf::logic_error if starts or stops contains nulls. * - * @param strings Strings column for this operation - * @param starts First character positions to begin the substring - * @param stops Last character (exclusive) positions to end the substring - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings column for this operation. + * @param starts First character positions to begin the substring. + * @param stops Last character (exclusive) positions to end the substring. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New strings column with sorted elements of this instance. */ std::unique_ptr slice_strings( @@ -135,11 +135,11 @@ std::unique_ptr slice_strings( * r = ['nvidia.com', null, 'google.com', '', 'foo'] * @endcode * - * @param strings Strings instance for this operation - * @param delimiter UTF-8 encoded string to search for in each string + * @param strings Strings instance for this operation. + * @param delimiter UTF-8 encoded string to search for in each string. * @param count Number of times to search for delimiter in each string. If the value is positive, * delimiter is searched from left to right; else, it is searched from right to left. - * @param mr Resource for allocating device memory + * @param mr Resource for allocating device memory. * @return New strings column containing the substrings. */ std::unique_ptr slice_strings( @@ -185,11 +185,11 @@ std::unique_ptr slice_strings( * @throw cudf::logic_error if the number of rows in @p strings and @p delimiter_strings do not * match. * - * @param strings Strings instance for this operation - * @param delimiter_strings UTF-8 encoded string for each row + * @param strings Strings instance for this operation. + * @param delimiter_strings UTF-8 encoded string for each row. * @param count Number of times to search for delimiter in each string. If the value is positive, * delimiter is searched from left to right; else, it is searched from right to left. - * @param mr Resource for allocating device memory + * @param mr Resource for allocating device memory. * @return New strings column containing the substrings. */ std::unique_ptr slice_strings( diff --git a/cpp/include/cudf/strings/translate.hpp b/cpp/include/cudf/strings/translate.hpp index de23cc1d4c2..0cbf6b22029 100644 --- a/cpp/include/cudf/strings/translate.hpp +++ b/cpp/include/cudf/strings/translate.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019-2022, NVIDIA CORPORATION. + * Copyright (c) 2019-2021, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,9 +47,9 @@ namespace strings { * r is now ["AA", "", "cccc", "AcQ"] * @endcode * - * @param strings Strings instance for this operation - * @param chars_table Table of UTF-8 character mappings - * @param mr Device memory resource used to allocate the returned column's device memory + * @param strings Strings instance for this operation. + * @param chars_table Table of UTF-8 character mappings. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with padded strings. */ std::unique_ptr translate( @@ -87,12 +87,12 @@ enum class filter_type : bool { * * @throw cudf::logic_error if `replacement` is invalid * - * @param strings Strings instance for this operation - * @param characters_to_filter Table of character ranges to filter on + * @param strings Strings instance for this operation. + * @param characters_to_filter Table of character ranges to filter on. * @param keep_characters If true, the `characters_to_filter` are retained and all other characters * are removed. - * @param replacement Optional replacement string for each character removed - * @param mr Device memory resource used to allocate the returned column's device memory + * @param replacement Optional replacement string for each character removed. + * @param mr Device memory resource used to allocate the returned column's device memory. * @return New column with filtered strings. */ std::unique_ptr filter_characters( diff --git a/cpp/include/cudf/strings/wrap.hpp b/cpp/include/cudf/strings/wrap.hpp index c36ed43292d..0ca8e30b644 100644 --- a/cpp/include/cudf/strings/wrap.hpp +++ b/cpp/include/cudf/strings/wrap.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020-2022, NVIDIA CORPORATION. + * Copyright (c) 2020, NVIDIA CORPORATION. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -55,8 +55,8 @@ namespace strings { * wrapped_string_tbl = ["the quick\nbrown fox\njumped over\nthe lazy\nbrown dog", "hello, world"] * ``` * - * @param[in] strings String column - * @param[in] width Maximum character width of a line within each string + * @param[in] strings String column. + * @param[in] width Maximum character width of a line within each string. * @param[in] mr Device memory resource used to allocate the returned column's device memory * @return Column of wrapped strings. */