mark_join.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 
6 #pragma once
7 
8 #include <cudf/join/join.hpp>
10 #include <cudf/types.hpp>
12 #include <cudf/utilities/export.hpp>
14 
15 #include <rmm/cuda_stream_view.hpp>
16 #include <rmm/device_uvector.hpp>
17 
18 #include <memory>
19 
25 namespace CUDF_EXPORT cudf {
26 
32 namespace detail {
33 class mark_join;
34 } // namespace detail
35 
65 class mark_join {
66  public:
67  mark_join() = delete;
68  ~mark_join();
69  mark_join(mark_join const&) = delete;
70  mark_join(mark_join&&) = delete;
71  mark_join& operator=(mark_join const&) = delete;
72  mark_join& operator=(mark_join&&) = delete;
73 
84  cudf::null_equality compare_nulls,
85  cudf::join_prefilter prefilter,
87  cuda::mr::any_resource<cuda::mr::device_accessible> mr =
89 
104  double load_factor,
106  cudf::join_prefilter prefilter = cudf::join_prefilter::NO,
108  cuda::mr::any_resource<cuda::mr::device_accessible> mr =
110 
119  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> semi_join(
120  cudf::table_view const& right,
123 
132  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> anti_join(
133  cudf::table_view const& right,
136 
137  private:
138  std::unique_ptr<cudf::detail::mark_join> _impl;
139 };
140  // end of group
142 
143 } // namespace CUDF_EXPORT cudf
Mark-based hash join for semi/anti join with left table reuse.
Definition: mark_join.hpp:65
std::unique_ptr< rmm::device_uvector< size_type > > anti_join(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()) const
Returns left row indices that have no match in the right table.
std::unique_ptr< rmm::device_uvector< size_type > > semi_join(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()) const
Returns left row indices that have at least one match in the right table.
mark_join(cudf::table_view const &left, cudf::null_equality compare_nulls, cudf::join_prefilter prefilter, rmm::cuda_stream_view stream=cudf::get_default_stream(), cuda::mr::any_resource< cuda::mr::device_accessible > mr=cudf::get_current_device_resource_ref())
Constructs a mark join object with explicit prefilter selection.
mark_join(cudf::table_view const &left, double load_factor, cudf::null_equality compare_nulls=cudf::null_equality::EQUAL, cudf::join_prefilter prefilter=cudf::join_prefilter::NO, rmm::cuda_stream_view stream=cudf::get_default_stream(), cuda::mr::any_resource< cuda::mr::device_accessible > mr=cudf::get_current_device_resource_ref())
Constructs a mark join object with explicit prefilter selection and the given load factor.
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:206
APIs for querying the default CUDA stream and per-thread default stream status.
join_prefilter
Specifies whether a join implementation should apply an optional prefilter that reduces candidate row...
Definition: join.hpp:60
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::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
null_equality
Enum to consider two nulls as equal or unequal.
Definition: types.hpp:132
@ EQUAL
nulls compare equal
Common types and utilities shared by cuDF's join APIs.
APIs for getting and setting the current device memory resource.
cuDF interfaces
Definition: host_udf.hpp:26
Class definitions for (mutable)_table_view
Type declarations for libcudf.