Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add missed documentation in PR #10870 #11056

Closed
wants to merge 1 commit into from
Closed

add missed documentation in PR #10870 #11056

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion cpp/include/cudf/table/experimental/row_operators.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <typename Comparator>
struct less_comparator : weak_ordering_comparator_impl<Comparator, weak_ordering::LESS> {
/**
* @brief Constructs a less_comparator
*
* @param comparator The comparator to wrap
*/
less_comparator(Comparator const& comparator)
: weak_ordering_comparator_impl<Comparator, weak_ordering::LESS>{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 <typename Comparator>
struct less_equivalent_comparator
: weak_ordering_comparator_impl<Comparator, weak_ordering::LESS, weak_ordering::EQUIVALENT> {
/**
* @brief Constructs a less_equivalent_comparator
*
* @param comparator The comparator to wrap
*/
less_equivalent_comparator(Comparator const& comparator)
: weak_ordering_comparator_impl<Comparator, weak_ordering::LESS, weak_ordering::EQUIVALENT>{
comparator}
Expand Down Expand Up @@ -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 <typename Nullate,
typename PhysicalElementComparator = sorting_physical_element_comparator>
auto less_equivalent(Nullate nullate = {},
Expand Down Expand Up @@ -781,6 +799,7 @@ class two_table_comparator {
comparator}}};
}

/// @copydoc less()
template <typename Nullate,
typename PhysicalElementComparator = sorting_physical_element_comparator>
auto less_equivalent(Nullate nullate = {},
Expand Down