mark_join.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <cudf/join/join.hpp>
#include <cudf/table/table_view.hpp>
#include <cudf/types.hpp>
#include <cudf/utilities/default_stream.hpp>
#include <cudf/utilities/export.hpp>
#include <cudf/utilities/memory_resource.hpp>
 
#include <rmm/cuda_stream_view.hpp>
#include <rmm/device_uvector.hpp>
 
#include <memory>
 
namespace CUDF_EXPORT cudf {
 
namespace detail {
class mark_join;
}  // namespace detail
 
class mark_join {
 public:
  mark_join() = delete;
  ~mark_join();
  mark_join(mark_join const&)            = delete;
  mark_join(mark_join&&)                 = delete;
  mark_join& operator=(mark_join const&) = delete;
  mark_join& operator=(mark_join&&)      = delete;
 
  // rapids-pre-commit-hooks: disable-next-line
  [[deprecated(
    "Use the overload accepting cudf::join_prefilter instead."
    " This overload will be removed in the next release.")]]
  mark_join(cudf::table_view const& build,
            cudf::null_equality compare_nulls = null_equality::EQUAL,
            rmm::cuda_stream_view stream      = cudf::get_default_stream());
 
  mark_join(cudf::table_view const& build,
            cudf::null_equality compare_nulls,
            cudf::join_prefilter prefilter,
            rmm::cuda_stream_view stream = cudf::get_default_stream());
 
  // rapids-pre-commit-hooks: disable-next-line
  [[deprecated(
    "Use the overload accepting cudf::join_prefilter instead."
    " This overload will be removed in the next release.")]]
  mark_join(cudf::table_view const& build,
            cudf::null_equality compare_nulls,
            double load_factor,
            rmm::cuda_stream_view stream = cudf::get_default_stream());
 
  mark_join(cudf::table_view const& build,
            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());
 
  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> semi_join(
    cudf::table_view const& probe,
    rmm::cuda_stream_view stream      = cudf::get_default_stream(),
    rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
  [[nodiscard]] std::unique_ptr<rmm::device_uvector<size_type>> anti_join(
    cudf::table_view const& probe,
    rmm::cuda_stream_view stream      = cudf::get_default_stream(),
    rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
 private:
  std::unique_ptr<cudf::detail::mark_join> _impl;
};
  // end of group
 
}  // namespace CUDF_EXPORT cudf