filtered_join.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2025, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#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 <utility>
 
namespace CUDF_EXPORT cudf {
 
namespace detail {
class filtered_join;
}  // namespace detail
 
enum class set_as_build_table { LEFT, RIGHT };
 
class filtered_join {
 public:
  filtered_join() = delete;
  ~filtered_join();
  filtered_join(filtered_join const&)            = delete;
  filtered_join(filtered_join&&)                 = delete;
  filtered_join& operator=(filtered_join const&) = delete;
  filtered_join& operator=(filtered_join&&)      = delete;
 
  filtered_join(cudf::table_view const& build,
                cudf::null_equality compare_nulls = null_equality::EQUAL,
                set_as_build_table reuse_tbl      = set_as_build_table::RIGHT,
                rmm::cuda_stream_view stream      = cudf::get_default_stream());
 
  filtered_join(cudf::table_view const& build,
                null_equality compare_nulls  = null_equality::EQUAL,
                set_as_build_table reuse_tbl = set_as_build_table::RIGHT,
                double load_factor           = 0.5,
                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:
  set_as_build_table _reuse_tbl;
  std::unique_ptr<cudf::detail::filtered_join> _impl;  
};
  // end of group
 
}  // namespace CUDF_EXPORT cudf