set_operations.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022-2023, 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/column/column.hpp>
21 #include <cudf/types.hpp>
22 
24 
25 namespace cudf::lists {
59 std::unique_ptr<column> have_overlap(
60  lists_column_view const& lhs,
61  lists_column_view const& rhs,
62  null_equality nulls_equal = null_equality::EQUAL,
66 
96 std::unique_ptr<column> intersect_distinct(
97  lists_column_view const& lhs,
98  lists_column_view const& rhs,
99  null_equality nulls_equal = null_equality::EQUAL,
103 
133 std::unique_ptr<column> union_distinct(
134  lists_column_view const& lhs,
135  lists_column_view const& rhs,
136  null_equality nulls_equal = null_equality::EQUAL,
140 
170 std::unique_ptr<column> difference_distinct(
171  lists_column_view const& lhs,
172  lists_column_view const& rhs,
173  null_equality nulls_equal = null_equality::EQUAL,
177  // end of group
179 } // namespace cudf::lists
Given a column-view of lists type, an instance of this class provides a wrapper on this compound colu...
Class definition for cudf::column.
device_memory_resource * get_current_device_resource()
std::unique_ptr< column > intersect_distinct(lists_column_view const &lhs, lists_column_view const &rhs, 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::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Create a lists column of distinct elements common to two input lists columns.
std::unique_ptr< column > have_overlap(lists_column_view const &lhs, lists_column_view const &rhs, 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::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Check if lists at each row of the given lists columns overlap.
std::unique_ptr< column > difference_distinct(lists_column_view const &lhs, lists_column_view const &rhs, 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::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Create a lists column of distinct elements found only in the left input column.
std::unique_ptr< column > union_distinct(lists_column_view const &lhs, lists_column_view const &rhs, 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::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
Create a lists column of distinct elements found in either of two input lists columns.
null_equality
Enum to consider two nulls as equal or unequal.
Definition: types.hpp:135
nan_equality
Enum to consider different elements (of floating point types) holding NaN value as equal or unequal.
Definition: types.hpp:127
@ EQUAL
nulls compare equal
@ ALL_EQUAL
All NaNs compare equal, regardless of sign.
Class definition for cudf::lists_column_view.
Lists column APIs.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
Type declarations for libcudf.