sorting.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2024, NVIDIA CORPORATION.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include <cudf/aggregation.hpp>
20 #include <cudf/types.hpp>
22 
23 #include <rmm/mr/device/per_device_resource.hpp>
24 #include <rmm/resource_ref.hpp>
25 
26 #include <memory>
27 #include <vector>
28 
29 namespace cudf {
30 
53 std::unique_ptr<column> sorted_order(
54  table_view const& input,
55  std::vector<order> const& column_order = {},
56  std::vector<null_order> const& null_precedence = {},
57  rmm::cuda_stream_view stream = cudf::get_default_stream(),
58  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
59 
68 std::unique_ptr<column> stable_sorted_order(
69  table_view const& input,
70  std::vector<order> const& column_order = {},
71  std::vector<null_order> const& null_precedence = {},
72  rmm::cuda_stream_view stream = cudf::get_default_stream(),
73  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
74 
93  std::vector<order> const& column_order,
94  std::vector<null_order> const& null_precedence,
95  rmm::cuda_stream_view stream = cudf::get_default_stream());
96 
112 std::unique_ptr<table> sort(
113  table_view const& input,
114  std::vector<order> const& column_order = {},
115  std::vector<null_order> const& null_precedence = {},
116  rmm::cuda_stream_view stream = cudf::get_default_stream(),
117  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
118 
124 std::unique_ptr<table> stable_sort(
125  table_view const& input,
126  std::vector<order> const& column_order = {},
127  std::vector<null_order> const& null_precedence = {},
128  rmm::cuda_stream_view stream = cudf::get_default_stream(),
129  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
130 
153 std::unique_ptr<table> sort_by_key(
154  table_view const& values,
155  table_view const& keys,
156  std::vector<order> const& column_order = {},
157  std::vector<null_order> const& null_precedence = {},
158  rmm::cuda_stream_view stream = cudf::get_default_stream(),
159  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
160 
166 std::unique_ptr<table> stable_sort_by_key(
167  table_view const& values,
168  table_view const& keys,
169  std::vector<order> const& column_order = {},
170  std::vector<null_order> const& null_precedence = {},
171  rmm::cuda_stream_view stream = cudf::get_default_stream(),
172  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
173 
204 std::unique_ptr<column> rank(
205  column_view const& input,
206  rank_method method,
207  order column_order,
208  null_policy null_handling,
209  null_order null_precedence,
210  bool percentage,
211  rmm::cuda_stream_view stream = cudf::get_default_stream(),
212  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
213 
257 std::unique_ptr<column> segmented_sorted_order(
258  table_view const& keys,
259  column_view const& segment_offsets,
260  std::vector<order> const& column_order = {},
261  std::vector<null_order> const& null_precedence = {},
262  rmm::cuda_stream_view stream = cudf::get_default_stream(),
263  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
264 
270 std::unique_ptr<column> stable_segmented_sorted_order(
271  table_view const& keys,
272  column_view const& segment_offsets,
273  std::vector<order> const& column_order = {},
274  std::vector<null_order> const& null_precedence = {},
275  rmm::cuda_stream_view stream = cudf::get_default_stream(),
276  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
277 
325 std::unique_ptr<table> segmented_sort_by_key(
326  table_view const& values,
327  table_view const& keys,
328  column_view const& segment_offsets,
329  std::vector<order> const& column_order = {},
330  std::vector<null_order> const& null_precedence = {},
331  rmm::cuda_stream_view stream = cudf::get_default_stream(),
332  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
333 
339 std::unique_ptr<table> stable_segmented_sort_by_key(
340  table_view const& values,
341  table_view const& keys,
342  column_view const& segment_offsets,
343  std::vector<order> const& column_order = {},
344  std::vector<null_order> const& null_precedence = {},
345  rmm::cuda_stream_view stream = cudf::get_default_stream(),
346  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
347  // end of group
349 } // namespace 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:187
A set of cudf::column's of the same size.
Definition: table.hpp:41
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=rmm::mr::get_current_device_resource())
Computes the row indices that would produce input in a lexicographical sorted order.
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=rmm::mr::get_current_device_resource())
Computes the ranks of input column in sorted order.
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=rmm::mr::get_current_device_resource())
Performs a lexicographic sort of the rows of a table.
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=rmm::mr::get_current_device_resource())
Returns sorted order after sorting each segment in the table.
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 > 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=rmm::mr::get_current_device_resource())
Performs a key-value sort.
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=rmm::mr::get_current_device_resource())
Performs a key-value stable sort.
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=rmm::mr::get_current_device_resource())
Computes the row indices that would produce input in a stable lexicographical sorted order.
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=rmm::mr::get_current_device_resource())
Performs a stable lexicographic sort of the rows of a table.
rank_method
Tie-breaker method to use for ranking the column.
Definition: aggregation.hpp:53
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=rmm::mr::get_current_device_resource())
Performs a lexicographic segmented sort of a table.
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=rmm::mr::get_current_device_resource())
Returns sorted order after stably sorting each segment in the table.
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=rmm::mr::get_current_device_resource())
Performs a stably lexicographic segmented sort of a table.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
null_order
Indicates how null values compare against all other values.
Definition: types.hpp:157
null_policy
Enum to specify whether to include nulls or exclude nulls.
Definition: types.hpp:124
order
Indicates the order in which elements should be sorted.
Definition: types.hpp:116
cuDF interfaces
Definition: aggregation.hpp:34
Type declarations for libcudf.