join/join.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2025, 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 
20 #include <cudf/types.hpp>
22 #include <cudf/utilities/export.hpp>
24 
25 #include <rmm/cuda_stream_view.hpp>
26 #include <rmm/device_uvector.hpp>
27 
28 namespace CUDF_EXPORT cudf {
29 
69 std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
70  std::unique_ptr<rmm::device_uvector<size_type>>>
71 inner_join(cudf::table_view const& left_keys,
72  cudf::table_view const& right_keys,
73  null_equality compare_nulls = null_equality::EQUAL,
76 
111 std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
112  std::unique_ptr<rmm::device_uvector<size_type>>>
113 left_join(cudf::table_view const& left_keys,
114  cudf::table_view const& right_keys,
115  null_equality compare_nulls = null_equality::EQUAL,
118 
152 std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
153  std::unique_ptr<rmm::device_uvector<size_type>>>
154 full_join(cudf::table_view const& left_keys,
155  cudf::table_view const& right_keys,
156  null_equality compare_nulls = null_equality::EQUAL,
159 
183 std::unique_ptr<rmm::device_uvector<size_type>> left_semi_join(
184  cudf::table_view const& left_keys,
185  cudf::table_view const& right_keys,
186  null_equality compare_nulls = null_equality::EQUAL,
189 
216 std::unique_ptr<rmm::device_uvector<size_type>> left_anti_join(
217  cudf::table_view const& left_keys,
218  cudf::table_view const& right_keys,
219  null_equality compare_nulls = null_equality::EQUAL,
222 
246 std::unique_ptr<cudf::table> cross_join(
247  cudf::table_view const& left,
248  cudf::table_view const& right,
251  // end of group
253 
254 } // namespace CUDF_EXPORT cudf
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:200
std::pair< std::unique_ptr< rmm::device_uvector< size_type > >, std::unique_ptr< rmm::device_uvector< size_type > > > left_join(cudf::table_view const &left_keys, cudf::table_view const &right_keys, null_equality compare_nulls=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a pair of row index vectors corresponding to a left join between the specified tables.
std::pair< std::unique_ptr< rmm::device_uvector< size_type > >, std::unique_ptr< rmm::device_uvector< size_type > > > full_join(cudf::table_view const &left_keys, cudf::table_view const &right_keys, null_equality compare_nulls=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a pair of row index vectors corresponding to a full join between the specified tables.
std::unique_ptr< rmm::device_uvector< size_type > > left_anti_join(cudf::table_view const &left_keys, cudf::table_view const &right_keys, null_equality compare_nulls=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a vector of row indices corresponding to a left anti join between the specified tables.
std::unique_ptr< rmm::device_uvector< size_type > > left_semi_join(cudf::table_view const &left_keys, cudf::table_view const &right_keys, null_equality compare_nulls=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a vector of row indices corresponding to a left semi-join between the specified tables.
std::pair< std::unique_ptr< rmm::device_uvector< size_type > >, std::unique_ptr< rmm::device_uvector< size_type > > > inner_join(cudf::table_view const &left_keys, cudf::table_view const &right_keys, null_equality compare_nulls=null_equality::EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Returns a pair of row index vectors corresponding to an inner join between the specified tables.
std::unique_ptr< cudf::table > cross_join(cudf::table_view const &left, cudf::table_view const &right, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Performs a cross join on two tables (left, right)
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
null_equality
Enum to consider two nulls as equal or unequal.
Definition: types.hpp:151
cuDF interfaces
Definition: host_udf.hpp:37
Class definitions for (mutable)_table_view
Type declarations for libcudf.