stream_compaction.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/types.hpp>
21 #include <cudf/utilities/export.hpp>
23 
24 #include <memory>
25 #include <vector>
26 
27 namespace CUDF_EXPORT cudf {
73 std::unique_ptr<table> drop_nulls(
74  table_view const& input,
75  std::vector<size_type> const& keys,
76  cudf::size_type keep_threshold,
79 
107 std::unique_ptr<table> drop_nulls(
108  table_view const& input,
109  std::vector<size_type> const& keys,
112 
151 std::unique_ptr<table> drop_nans(
152  table_view const& input,
153  std::vector<size_type> const& keys,
154  cudf::size_type keep_threshold,
157 
186 std::unique_ptr<table> drop_nans(
187  table_view const& input,
188  std::vector<size_type> const& keys,
191 
214 std::unique_ptr<table> apply_boolean_mask(
215  table_view const& input,
216  column_view const& boolean_mask,
219 
224  KEEP_ANY = 0,
225  KEEP_FIRST,
226  KEEP_LAST,
227  KEEP_NONE
228 };
229 
258 std::unique_ptr<table> unique(
259  table_view const& input,
260  std::vector<size_type> const& keys,
262  null_equality nulls_equal = null_equality::EQUAL,
265 
286 std::unique_ptr<table> distinct(
287  table_view const& input,
288  std::vector<size_type> const& keys,
289  duplicate_keep_option keep = duplicate_keep_option::KEEP_ANY,
290  null_equality nulls_equal = null_equality::EQUAL,
291  nan_equality nans_equal = nan_equality::ALL_EQUAL,
294 
309 std::unique_ptr<column> distinct_indices(
310  table_view const& input,
311  duplicate_keep_option keep = duplicate_keep_option::KEEP_ANY,
312  null_equality nulls_equal = null_equality::EQUAL,
313  nan_equality nans_equal = nan_equality::ALL_EQUAL,
316 
340 std::unique_ptr<table> stable_distinct(
341  table_view const& input,
342  std::vector<size_type> const& keys,
343  duplicate_keep_option keep = duplicate_keep_option::KEEP_ANY,
344  null_equality nulls_equal = null_equality::EQUAL,
345  nan_equality nans_equal = nan_equality::ALL_EQUAL,
348 
366  null_policy null_handling,
367  nan_policy nan_handling,
369 
381  null_equality nulls_equal = null_equality::EQUAL,
383 
406  null_policy null_handling,
407  nan_policy nan_handling,
409 
421  null_equality nulls_equal = null_equality::EQUAL,
423 
425 } // namespace CUDF_EXPORT cudf
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:200
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.
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
std::unique_ptr< table > drop_nulls(table_view const &input, std::vector< size_type > const &keys, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Filters a table to remove null elements.
std::unique_ptr< column > distinct_indices(table_view const &input, duplicate_keep_option keep=duplicate_keep_option::KEEP_ANY, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a column of indices of all distinct rows in the input table.
std::unique_ptr< table > unique(table_view const &input, std::vector< size_type > const &keys, duplicate_keep_option keep, null_equality nulls_equal=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a new table with consecutive duplicate rows removed.
std::unique_ptr< table > drop_nans(table_view const &input, std::vector< size_type > const &keys, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Filters a table to remove NANs.
duplicate_keep_option
Choices for drop_duplicates API for retainment of duplicate rows.
std::unique_ptr< table > apply_boolean_mask(table_view const &input, column_view const &boolean_mask, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Filters input using boolean_mask of boolean values as a mask.
cudf::size_type distinct_count(table_view const &input, null_equality nulls_equal=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream())
Count the distinct rows in a table.
std::unique_ptr< table > stable_distinct(table_view const &input, std::vector< size_type > const &keys, duplicate_keep_option keep=duplicate_keep_option::KEEP_ANY, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a new table without duplicate rows, preserving input order.
std::unique_ptr< table > distinct(table_view const &input, std::vector< size_type > const &keys, duplicate_keep_option keep=duplicate_keep_option::KEEP_ANY, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a new table without duplicate rows.
cudf::size_type unique_count(table_view const &input, null_equality nulls_equal=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream())
Count the number of consecutive groups of equivalent rows in a table.
@ KEEP_ANY
Keep an unspecified occurrence.
@ KEEP_NONE
Keep no (remove all) occurrences of duplicates.
@ KEEP_LAST
Keep last occurrence.
@ KEEP_FIRST
Keep first occurrence.
null_equality
Enum to consider two nulls as equal or unequal.
Definition: types.hpp:151
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:95
null_policy
Enum to specify whether to include nulls or exclude nulls.
Definition: types.hpp:126
nan_policy
Enum to treat NaN floating point value as null or non-null element.
Definition: types.hpp:134
nan_equality
Enum to consider different elements (of floating point types) holding NaN value as equal or unequal.
Definition: types.hpp:143
cuDF interfaces
Definition: host_udf.hpp:39
Type declarations for libcudf.