sorting.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2019-2025, NVIDIA CORPORATION.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 
6 #pragma once
7 
8 #include <cudf/aggregation.hpp>
9 #include <cudf/types.hpp>
11 #include <cudf/utilities/export.hpp>
13 
14 #include <memory>
15 #include <vector>
16 
17 namespace CUDF_EXPORT cudf {
18 
41 std::unique_ptr<column> sorted_order(
42  table_view const& input,
43  std::vector<order> const& column_order = {},
44  std::vector<null_order> const& null_precedence = {},
47 
56 std::unique_ptr<column> stable_sorted_order(
57  table_view const& input,
58  std::vector<order> const& column_order = {},
59  std::vector<null_order> const& null_precedence = {},
62 
81  std::vector<order> const& column_order,
82  std::vector<null_order> const& null_precedence,
84 
100 std::unique_ptr<table> sort(
101  table_view const& input,
102  std::vector<order> const& column_order = {},
103  std::vector<null_order> const& null_precedence = {},
106 
112 std::unique_ptr<table> stable_sort(
113  table_view const& input,
114  std::vector<order> const& column_order = {},
115  std::vector<null_order> const& null_precedence = {},
118 
141 std::unique_ptr<table> sort_by_key(
142  table_view const& values,
143  table_view const& keys,
144  std::vector<order> const& column_order = {},
145  std::vector<null_order> const& null_precedence = {},
148 
154 std::unique_ptr<table> stable_sort_by_key(
155  table_view const& values,
156  table_view const& keys,
157  std::vector<order> const& column_order = {},
158  std::vector<null_order> const& null_precedence = {},
161 
219 std::unique_ptr<column> rank(
220  column_view const& input,
221  rank_method method,
222  order column_order,
223  null_policy null_handling,
224  null_order null_precedence,
225  bool percentage,
228 
272 std::unique_ptr<column> segmented_sorted_order(
273  table_view const& keys,
274  column_view const& segment_offsets,
275  std::vector<order> const& column_order = {},
276  std::vector<null_order> const& null_precedence = {},
279 
285 std::unique_ptr<column> stable_segmented_sorted_order(
286  table_view const& keys,
287  column_view const& segment_offsets,
288  std::vector<order> const& column_order = {},
289  std::vector<null_order> const& null_precedence = {},
292 
340 std::unique_ptr<table> segmented_sort_by_key(
341  table_view const& values,
342  table_view const& keys,
343  column_view const& segment_offsets,
344  std::vector<order> const& column_order = {},
345  std::vector<null_order> const& null_precedence = {},
348 
354 std::unique_ptr<table> stable_segmented_sort_by_key(
355  table_view const& values,
356  table_view const& keys,
357  column_view const& segment_offsets,
358  std::vector<order> const& column_order = {},
359  std::vector<null_order> const& null_precedence = {},
362 
379 std::unique_ptr<column> top_k(
380  column_view const& col,
381  size_type k,
382  order topk_order = order::DESCENDING,
385 
402 std::unique_ptr<column> top_k_order(
403  column_view const& col,
404  size_type k,
405  order topk_order = order::DESCENDING,
408 
437 std::unique_ptr<column> segmented_top_k(
438  column_view const& col,
439  column_view const& segment_offsets,
440  size_type k,
441  order topk_order = order::DESCENDING,
444 
473 std::unique_ptr<column> segmented_top_k_order(
474  column_view const& col,
475  column_view const& segment_offsets,
476  size_type k,
477  order topk_order = order::DESCENDING,
480  // end of group
482 } // namespace CUDF_EXPORT cudf
Representation for specifying desired aggregations from aggregation-based APIs, e....
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:189
A set of cudf::column's of the same size.
Definition: table.hpp:29
std::unique_ptr< column > top_k(column_view const &col, size_type k, order topk_order=order::DESCENDING, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the top k values of a column.
std::unique_ptr< column > segmented_top_k_order(column_view const &col, column_view const &segment_offsets, size_type k, order topk_order=order::DESCENDING, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the indices of the top k values within each segment of a column.
std::unique_ptr< column > top_k_order(column_view const &col, size_type k, order topk_order=order::DESCENDING, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the indices of the top k values of a column.
std::unique_ptr< column > stable_segmented_sorted_order(table_view const &keys, column_view const &segment_offsets, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns sorted order after stably sorting each segment in the table.
std::unique_ptr< table > stable_sort(table_view const &input, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a stable lexicographic sort of the rows of a table.
std::unique_ptr< table > sort(table_view const &input, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a lexicographic sort of the rows of a table.
std::unique_ptr< column > rank(column_view const &input, rank_method method, order column_order, null_policy null_handling, null_order null_precedence, bool percentage, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the ranks of input column in sorted order.
std::unique_ptr< table > stable_sort_by_key(table_view const &values, table_view const &keys, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a key-value stable sort.
std::unique_ptr< column > sorted_order(table_view const &input, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the row indices that would produce input in a lexicographical sorted order.
bool is_sorted(cudf::table_view const &table, std::vector< order > const &column_order, std::vector< null_order > const &null_precedence, rmm::cuda_stream_view stream=cudf::get_default_stream())
Checks whether the rows of a table are sorted in a lexicographical order.
std::unique_ptr< table > stable_segmented_sort_by_key(table_view const &values, table_view const &keys, column_view const &segment_offsets, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a stably lexicographic segmented sort of a table.
std::unique_ptr< table > sort_by_key(table_view const &values, table_view const &keys, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a key-value sort.
std::unique_ptr< column > segmented_sorted_order(table_view const &keys, column_view const &segment_offsets, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns sorted order after sorting each segment in the table.
rank_method
Tie-breaker method to use for ranking the column.
Definition: aggregation.hpp:43
std::unique_ptr< column > stable_sorted_order(table_view const &input, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the row indices that would produce input in a stable lexicographical sorted order.
std::unique_ptr< table > segmented_sort_by_key(table_view const &values, table_view const &keys, column_view const &segment_offsets, std::vector< order > const &column_order={}, std::vector< null_order > const &null_precedence={}, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a lexicographic segmented sort of a table.
std::unique_ptr< column > segmented_top_k(column_view const &col, column_view const &segment_offsets, size_type k, order topk_order=order::DESCENDING, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Computes the top k values within each segment of a column.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
detail::cccl_async_resource_ref< cuda::mr::resource_ref< cuda::mr::device_accessible > > device_async_resource_ref
null_order
Indicates how null values compare against all other values.
Definition: types.hpp:148
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:84
null_policy
Enum to specify whether to include nulls or exclude nulls.
Definition: types.hpp:115
order
Indicates the order in which elements should be sorted.
Definition: types.hpp:107
cuDF interfaces
Definition: host_udf.hpp:26
Type declarations for libcudf.