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

Improve aggregation documentation #16822

Merged
merged 3 commits into from
Sep 19, 2024
Merged

Improve aggregation documentation #16822

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed571da
Improve aggregation documentation
PointKernel Sep 17, 2024
b604ae3
Apply suggestions from code review
PointKernel Sep 18, 2024
4439c16
Merge branch 'branch-24.10' into fix-agg-docs
PointKernel Sep 19, 2024
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
8 changes: 5 additions & 3 deletions cpp/include/cudf/detail/aggregation/aggregation.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1497,7 +1497,7 @@ AGG_KIND_MAPPING(aggregation::VARIANCE, var_aggregation);
*
* @tparam F Type of callable
* @param k The `aggregation::Kind` value to dispatch
* aram f The callable that accepts an `aggregation::Kind` non-type template
* @param f The callable that accepts an `aggregation::Kind` non-type template
* argument.
PointKernel marked this conversation as resolved.
Show resolved Hide resolved
* @param args Parameter pack forwarded to the `operator()` invocation
* @return Forwards the return value of the callable.
Expand Down Expand Up @@ -1626,6 +1626,8 @@ struct dispatch_source {
* parameter of the callable `F`
* @param k The `aggregation::Kind` used to dispatch an `aggregation::Kind`
* non-type template parameter for the second template parameter of the callable
* @param f The callable that accepts `data_type` and `aggregation::Kind` non-type template
* arguments.
PointKernel marked this conversation as resolved.
Show resolved Hide resolved
* @param args Parameter pack forwarded to the `operator()` invocation
* `F`.
*/
Expand All @@ -1644,8 +1646,8 @@ CUDF_HOST_DEVICE inline constexpr decltype(auto) dispatch_type_and_aggregation(d
* @brief Returns the target `data_type` for the specified aggregation k
* performed on elements of type source_type.
*
* aram source_type The element type to be aggregated
* aram k The aggregation
* @param source_type The element type to be aggregated
* @param k The aggregation
PointKernel marked this conversation as resolved.
Show resolved Hide resolved
* @return data_type The target_type of k performed on source_type
* elements
*/
Expand Down
Loading