roaring_bitmap.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <cudf/column/column.hpp>
#include <cudf/column/column_view.hpp>
#include <cudf/types.hpp>
#include <cudf/utilities/export.hpp>
#include <cudf/utilities/memory_resource.hpp>
#include <cudf/utilities/span.hpp>
 
#include <rmm/cuda_stream_view.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/std/cstddef>
 
#include <memory>
#include <span>
 
namespace CUDF_EXPORT cudf {
 
enum class roaring_bitmap_type : uint8_t {
  BITS_32 = 0,  
  BITS_64 = 1   
};
 
class roaring_bitmap {
 public:
  explicit roaring_bitmap(roaring_bitmap_type type,
                          std::span<cuda::std::byte const> serialized_bitmap_data);
 
  ~roaring_bitmap();
 
  roaring_bitmap(roaring_bitmap&& other) noexcept;
 
  roaring_bitmap& operator=(roaring_bitmap&& other) noexcept;
 
  roaring_bitmap(roaring_bitmap const&) = delete;
 
  roaring_bitmap& operator=(roaring_bitmap const&) = delete;
 
  void materialize(rmm::cuda_stream_view stream = cudf::get_default_stream()) const;
 
  [[nodiscard]] roaring_bitmap_type type() const;
 
  [[nodiscard]] bool empty() const;
 
  [[nodiscard]] cuda::std::size_t size() const;
 
  [[nodiscard]] cuda::std::size_t size_bytes() const;
 
  [[nodiscard]] std::unique_ptr<cudf::column> contains_async(
    cudf::column_view const& keys,
    rmm::cuda_stream_view stream      = cudf::get_default_stream(),
    rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref()) const;
 
  void contains_async(cudf::column_view const& keys,
                      cudf::mutable_column_view const& output,
                      rmm::cuda_stream_view stream) const;
 
 private:
  class impl;
  roaring_bitmap_type _type;
  std::unique_ptr<impl> _impl;
};
  // end of group
 
}  // namespace CUDF_EXPORT cudf