From 55e94340c045efde3402a13e147c9e33fb7f6b51 Mon Sep 17 00:00:00 2001 From: Karthikeyan Natarajan Date: Mon, 6 Jun 2022 22:58:42 +0530 Subject: [PATCH] add missed documentation in PR #10870 --- .../cudf/table/experimental/row_operators.cuh | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/cpp/include/cudf/table/experimental/row_operators.cuh b/cpp/include/cudf/table/experimental/row_operators.cuh index 2397f9bc6fb..cee117247b3 100644 --- a/cpp/include/cudf/table/experimental/row_operators.cuh +++ b/cpp/include/cudf/table/experimental/row_operators.cuh @@ -456,19 +456,36 @@ struct weak_ordering_comparator_impl { * @brief Wraps and interprets the result of device_row_comparator, true if the result is * weak_ordering::LESS meaning one row is lexicographically *less* than another row. * - * @tparam Nullate A cudf::nullate type describing whether to check for nulls. + * @tparam Comparator generic comparator that returns a weak_ordering */ template struct less_comparator : weak_ordering_comparator_impl { + /** + * @brief Constructs a less_comparator + * + * @param comparator The comparator to wrap + */ less_comparator(Comparator const& comparator) : weak_ordering_comparator_impl{comparator} { } }; +/** + * @brief Wraps and interprets the result of device_row_comparator, true if the result is + * weak_ordering::LESS or weak_ordering::EQUIVALENT meaning one row is lexicographically *less* than + * or *equivalent* to another row. + * + * @tparam Comparator generic comparator that returns a weak_ordering + */ template struct less_equivalent_comparator : weak_ordering_comparator_impl { + /** + * @brief Constructs a less_equivalent_comparator + * + * @param comparator The comparator to wrap + */ less_equivalent_comparator(Comparator const& comparator) : weak_ordering_comparator_impl{ comparator} @@ -644,6 +661,7 @@ class self_comparator { nullate, *d_t, *d_t, d_t->depths(), d_t->column_order(), d_t->null_precedence(), comparator}}; } + /// @copydoc less() template auto less_equivalent(Nullate nullate = {}, @@ -781,6 +799,7 @@ class two_table_comparator { comparator}}}; } + /// @copydoc less() template auto less_equivalent(Nullate nullate = {},