sort_merge_join.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * 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/export.hpp>
#include <cudf/utilities/memory_resource.hpp>
 
#include <rmm/device_uvector.hpp>
 
#include <cuda/stream>
 
#include <memory>
 
namespace CUDF_EXPORT cudf {
 
// Forward declaration
namespace detail {
class sort_merge_join;
}
 
class sort_merge_join {
 public:
  sort_merge_join() = delete;
  ~sort_merge_join();
  sort_merge_join(sort_merge_join const&)            = delete;
  sort_merge_join(sort_merge_join&&)                 = delete;
  sort_merge_join& operator=(sort_merge_join const&) = delete;
  sort_merge_join& operator=(sort_merge_join&&)      = delete;
 
  sort_merge_join(table_view const& right,
                  sorted is_right_sorted,
                  null_equality compare_nulls = null_equality::EQUAL,
                  cuda::stream_ref stream     = cudf::get_default_stream());
 
  std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
            std::unique_ptr<rmm::device_uvector<size_type>>>
  inner_join(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;
 
  [[deprecated(
    "The is_left_sorted parameter is ignored; use inner_join(left, stream, mr) "
    "instead.")]] std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
                            std::unique_ptr<rmm::device_uvector<size_type>>>
  inner_join(table_view const& left,
             sorted is_left_sorted,
             cuda::stream_ref stream           = cudf::get_default_stream(),
             rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
  std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
            std::unique_ptr<rmm::device_uvector<size_type>>>
  left_join(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;
 
  [[deprecated(
    "The is_left_sorted parameter is ignored; use left_join(left, stream, mr) "
    "instead.")]] std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
                            std::unique_ptr<rmm::device_uvector<size_type>>>
  left_join(table_view const& left,
            sorted is_left_sorted,
            cuda::stream_ref stream           = cudf::get_default_stream(),
            rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
  std::unique_ptr<join_match_context> inner_join_match_context(
    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;
 
  [[deprecated(
    "The is_left_sorted parameter is ignored; use inner_join_match_context(left, "
    "stream, mr) instead.")]] std::unique_ptr<join_match_context>
  inner_join_match_context(
    table_view const& left,
    sorted is_left_sorted,
    cuda::stream_ref stream           = cudf::get_default_stream(),
    rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
  std::pair<std::unique_ptr<rmm::device_uvector<size_type>>,
            std::unique_ptr<rmm::device_uvector<size_type>>>
  partitioned_inner_join(
    cudf::join_partition_context const& context,
    cuda::stream_ref stream           = cudf::get_default_stream(),
    rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
 private:
  using impl_type = cudf::detail::sort_merge_join;  
  std::unique_ptr<impl_type const> _impl;           
};
  // end of group
}  // namespace CUDF_EXPORT cudf