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/device_uvector.hpp>
16 
17 #include <cuda/stream>
18 
19 #include <memory>
20 
26 namespace CUDF_EXPORT cudf {
27 
33 namespace detail {
34 class mark_join;
35 } // namespace detail
36 
66 class mark_join {
67  public:
68  mark_join() = delete;
69  ~mark_join();
70  mark_join(mark_join const&) = delete;
71  mark_join(mark_join&&) = delete;
72  mark_join& operator=(mark_join const&) = delete;
73  mark_join& operator=(mark_join&&) = delete;
74 
85  cudf::null_equality compare_nulls,
86  cudf::join_prefilter prefilter,
87  cuda::stream_ref stream = cudf::get_default_stream(),
88  cuda::mr::any_resource<cuda::mr::device_accessible> mr =
90 
105  double load_factor,
107  cudf::join_prefilter prefilter = cudf::join_prefilter::NO,
108  cuda::stream_ref stream = cudf::get_default_stream(),
109  cuda::mr::any_resource<cuda::mr::device_accessible> mr =
111 
120  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> semi_join(
121  cudf::table_view const& right,
122  cuda::stream_ref stream = cudf::get_default_stream(),
124 
133  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> anti_join(
134  cudf::table_view const& right,
135  cuda::stream_ref stream = cudf::get_default_stream(),
137 
138  private:
139  std::unique_ptr<cudf::detail::mark_join> _impl;
140 };
141  // end of group
143 
144 } // namespace CUDF_EXPORT cudf
Mark-based hash join for semi/anti join with left table reuse.
Definition: mark_join.hpp:66
std::unique_ptr< rmm::device_uvector< size_type > > semi_join(cudf::table_view const &right, cuda::stream_ref 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, double load_factor, cudf::null_equality compare_nulls=cudf::null_equality::EQUAL, cudf::join_prefilter prefilter=cudf::join_prefilter::NO, cuda::stream_ref 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.
mark_join(cudf::table_view const &left, cudf::null_equality compare_nulls, cudf::join_prefilter prefilter, cuda::stream_ref 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.
std::unique_ptr< rmm::device_uvector< size_type > > anti_join(cudf::table_view const &right, cuda::stream_ref 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.
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
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
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:27
Class definitions for (mutable)_table_view
Type declarations for libcudf.