From 3d07badce7238db1b9132fdfc151765be70730fb Mon Sep 17 00:00:00 2001 From: Conor Hoekstra Date: Wed, 2 Feb 2022 16:28:19 -0500 Subject: [PATCH 1/3] Fix docs --- cpp/include/cudf/fixed_point/fixed_point.hpp | 38 ++++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/cpp/include/cudf/fixed_point/fixed_point.hpp b/cpp/include/cudf/fixed_point/fixed_point.hpp index 6a85428d8f0..1ad86c7775d 100644 --- a/cpp/include/cudf/fixed_point/fixed_point.hpp +++ b/cpp/include/cudf/fixed_point/fixed_point.hpp @@ -387,9 +387,9 @@ class fixed_point { /** * @brief operator + (for adding two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are added
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are added + * If `_scale`s are equal, `_value`s are added + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are added * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -402,9 +402,9 @@ class fixed_point { /** * @brief operator - (for subtracting two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are subtracted
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are subtracted + * If `_scale`s are equal, `_value`s are subtracted + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are subtracted * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -443,9 +443,9 @@ class fixed_point { /** * @brief operator == (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are compared + * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -459,8 +459,8 @@ class fixed_point { * @brief operator != (for comparing two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are compared + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -474,8 +474,8 @@ class fixed_point { * @brief operator <= (for comparing two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are compared + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -489,8 +489,8 @@ class fixed_point { * @brief operator >= (for comparing two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are compared + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -504,8 +504,8 @@ class fixed_point { * @brief operator < (for comparing two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are compared + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -519,8 +519,8 @@ class fixed_point { * @brief operator > (for comparing two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with smaller `_scale` is shifted to the - * greater `_scale`, and then `_value`s are compared + * If `_scale`s are not equal, number with larger `_scale` is shifted to the + * smaller `_scale`, and then `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` From 07ccc328bcc4f79bce98e663d244a875bafa440f Mon Sep 17 00:00:00 2001 From: Conor Hoekstra Date: Wed, 2 Feb 2022 16:38:38 -0500 Subject: [PATCH 2/3] Better wording --- cpp/include/cudf/fixed_point/fixed_point.hpp | 42 ++++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/cpp/include/cudf/fixed_point/fixed_point.hpp b/cpp/include/cudf/fixed_point/fixed_point.hpp index 1ad86c7775d..d8c01bcb1c5 100644 --- a/cpp/include/cudf/fixed_point/fixed_point.hpp +++ b/cpp/include/cudf/fixed_point/fixed_point.hpp @@ -388,8 +388,8 @@ class fixed_point { * @brief operator + (for adding two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are added - * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are added + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are added * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -403,8 +403,8 @@ class fixed_point { * @brief operator - (for subtracting two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are subtracted - * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are subtracted + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are subtracted * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -444,8 +444,8 @@ class fixed_point { * @brief operator == (for comparing two `fixed_point` numbers) * * If `_scale`s are equal, `_value`s are compared - * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are compared + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -458,9 +458,9 @@ class fixed_point { /** * @brief operator != (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are compared + * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -473,9 +473,9 @@ class fixed_point { /** * @brief operator <= (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are compared + * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -488,9 +488,9 @@ class fixed_point { /** * @brief operator >= (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are compared + * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -503,9 +503,9 @@ class fixed_point { /** * @brief operator < (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are compared + * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -518,9 +518,9 @@ class fixed_point { /** * @brief operator > (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared
- * If `_scale`s are not equal, number with larger `_scale` is shifted to the - * smaller `_scale`, and then `_value`s are compared + * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the + * smaller `_scale`, and then the `_value`s are compared * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` From 057365e44c52c00d8846c9f83e9de3b6bb855229 Mon Sep 17 00:00:00 2001 From: Conor Hoekstra Date: Wed, 2 Feb 2022 16:53:34 -0500 Subject: [PATCH 3/3] Add periods --- cpp/include/cudf/fixed_point/fixed_point.hpp | 38 ++++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/cpp/include/cudf/fixed_point/fixed_point.hpp b/cpp/include/cudf/fixed_point/fixed_point.hpp index d8c01bcb1c5..a7112ae415d 100644 --- a/cpp/include/cudf/fixed_point/fixed_point.hpp +++ b/cpp/include/cudf/fixed_point/fixed_point.hpp @@ -387,9 +387,9 @@ class fixed_point { /** * @brief operator + (for adding two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are added + * If `_scale`s are equal, `_value`s are added. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are added + * smaller `_scale`, and then the `_value`s are added. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -402,9 +402,9 @@ class fixed_point { /** * @brief operator - (for subtracting two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are subtracted + * If `_scale`s are equal, `_value`s are subtracted. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are subtracted + * smaller `_scale`, and then the `_value`s are subtracted. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -417,7 +417,7 @@ class fixed_point { /** * @brief operator * (for multiplying two `fixed_point` numbers) * - * `_scale`s are added and `_value`s are multiplied + * `_scale`s are added and `_value`s are multiplied. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -430,7 +430,7 @@ class fixed_point { /** * @brief operator / (for dividing two `fixed_point` numbers) * - * `_scale`s are subtracted and `_value`s are divided + * `_scale`s are subtracted and `_value`s are divided. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -443,9 +443,9 @@ class fixed_point { /** * @brief operator == (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are equal, `_value`s are compared. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are compared + * smaller `_scale`, and then the `_value`s are compared. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -458,9 +458,9 @@ class fixed_point { /** * @brief operator != (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are equal, `_value`s are compared. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are compared + * smaller `_scale`, and then the `_value`s are compared. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -473,9 +473,9 @@ class fixed_point { /** * @brief operator <= (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are equal, `_value`s are compared. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are compared + * smaller `_scale`, and then the `_value`s are compared. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -488,9 +488,9 @@ class fixed_point { /** * @brief operator >= (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are equal, `_value`s are compared. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are compared + * smaller `_scale`, and then the `_value`s are compared. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -503,9 +503,9 @@ class fixed_point { /** * @brief operator < (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are equal, `_value`s are compared. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are compared + * smaller `_scale`, and then the `_value`s are compared. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -518,9 +518,9 @@ class fixed_point { /** * @brief operator > (for comparing two `fixed_point` numbers) * - * If `_scale`s are equal, `_value`s are compared + * If `_scale`s are equal, `_value`s are compared. * If `_scale`s are not equal, the number with the larger `_scale` is shifted to the - * smaller `_scale`, and then the `_value`s are compared + * smaller `_scale`, and then the `_value`s are compared. * * @tparam Rep1 Representation type of number being added to `this` * @tparam Rad1 Radix (base) type of number being added to `this` @@ -534,7 +534,7 @@ class fixed_point { * @brief Method for creating a `fixed_point` number with a new `scale` * * The `fixed_point` number returned will have the same value, underlying representation and - * radix as `this`, the only thing changed is the scale + * radix as `this`, the only thing changed is the scale. * * @param scale The `scale` of the returned `fixed_point` number * @return `fixed_point` number with a new `scale`