filtered_join.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 
6 #pragma once
7 
9 #include <cudf/types.hpp>
11 #include <cudf/utilities/export.hpp>
13 
14 #include <rmm/device_uvector.hpp>
15 
16 #include <cuda/stream>
17 
24 namespace CUDF_EXPORT cudf {
25 
31 namespace detail {
35 class filtered_join;
36 } // namespace detail
37 
53  public:
54  filtered_join() = delete;
55  ~filtered_join();
56  filtered_join(filtered_join const&) = delete;
57  filtered_join(filtered_join&&) = delete;
58  filtered_join& operator=(filtered_join const&) = delete;
59  filtered_join& operator=(filtered_join&&) = delete;
60 
73  cudf::null_equality compare_nulls,
74  cuda::stream_ref stream,
75  cuda::mr::any_resource<cuda::mr::device_accessible> mr =
77 
95  cudf::null_equality compare_nulls,
96  double load_factor,
97  cuda::stream_ref stream,
98  cuda::mr::any_resource<cuda::mr::device_accessible> mr =
100 
121  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> semi_join(
122  cudf::table_view const& left,
123  cuda::stream_ref stream = cudf::get_default_stream(),
125 
146  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> anti_join(
147  cudf::table_view const& left,
148  cuda::stream_ref stream = cudf::get_default_stream(),
150 
151  private:
152  std::unique_ptr<cudf::detail::filtered_join> _impl;
153 };
154  // end of group
156 
157 } // namespace CUDF_EXPORT cudf
Filtered hash join that builds a hash table from the right (filter) table on creation and probes resu...
std::unique_ptr< rmm::device_uvector< size_type > > semi_join(cudf::table_view const &left, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref()) const
Returns a vector of row indices corresponding to a semi-join between the specified tables.
filtered_join(cudf::table_view const &right, cudf::null_equality compare_nulls, cuda::stream_ref stream, cuda::mr::any_resource< cuda::mr::device_accessible > mr=cudf::get_current_device_resource_ref())
Constructs a filtered hash join object for subsequent probe calls.
std::unique_ptr< rmm::device_uvector< size_type > > anti_join(cudf::table_view const &left, cuda::stream_ref stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref()) const
Returns a vector of row indices corresponding to an anti-join between the specified tables.
filtered_join(cudf::table_view const &right, cudf::null_equality compare_nulls, double load_factor, cuda::stream_ref stream, cuda::mr::any_resource< cuda::mr::device_accessible > mr=cudf::get_current_device_resource_ref())
Constructs a filtered hash join object for subsequent probe calls.
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.
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
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.