stream_compaction.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
7 #include <cudf/column/column.hpp>
10 #include <cudf/utilities/export.hpp>
12 
18 namespace CUDF_EXPORT cudf {
19 namespace lists {
20 
57 std::unique_ptr<column> apply_retention_mask(
58  lists_column_view const& input,
59  lists_column_view const& retention_mask,
60  cuda::stream_ref stream = cudf::get_default_stream(),
62 
75 [[deprecated("Use apply_retention_mask() instead")]] std::unique_ptr<column> apply_boolean_mask(
76  lists_column_view const& input,
77  lists_column_view const& boolean_mask,
78  cuda::stream_ref stream = cudf::get_default_stream(),
80 
112 std::unique_ptr<column> apply_deletion_mask(
113  lists_column_view const& input,
114  lists_column_view const& deletion_mask,
115  cuda::stream_ref stream = cudf::get_default_stream(),
117 
139 std::unique_ptr<column> distinct(
140  lists_column_view const& input,
141  null_equality nulls_equal = null_equality::EQUAL,
142  nan_equality nans_equal = nan_equality::ALL_EQUAL,
143  duplicate_keep_option keep_option = duplicate_keep_option::KEEP_ANY,
144  cuda::stream_ref stream = cudf::get_default_stream(),
146  // end of group
148 
149 } // namespace lists
150 } // namespace CUDF_EXPORT cudf
Given a column-view of lists type, an instance of this class provides a wrapper on this compound colu...
Class definition for cudf::column.
cuda::stream_ref 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::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
std::unique_ptr< table > apply_boolean_mask(table_view const &input, column_view const &boolean_mask, cuda::stream_ref 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.
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, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a new table without duplicate rows.
std::unique_ptr< table > apply_deletion_mask(table_view const &input, column_view const &deletion_mask, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Filters input using deletion_mask of boolean values as a mask.
duplicate_keep_option
Choices for drop_duplicates API for retainment of duplicate rows.
std::unique_ptr< table > apply_retention_mask(table_view const &input, column_view const &retention_mask, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Filters input using retention_mask of boolean values as a mask.
null_equality
Enum to consider two nulls as equal or unequal.
Definition: types.hpp:132
nan_equality
Enum to consider different elements (of floating point types) holding NaN value as equal or unequal.
Definition: types.hpp:124
Class definition for cudf::lists_column_view.
APIs for getting and setting the current device memory resource.
cuDF interfaces
Definition: host_udf.hpp:27
Column APIs for filtering rows.