null_mask.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <cudf/types.hpp>
#include <cudf/utilities/default_stream.hpp>
#include <cudf/utilities/export.hpp>
#include <cudf/utilities/memory_resource.hpp>
#include <cudf/utilities/span.hpp>
 
#include <rmm/device_buffer.hpp>
 
#include <cuda/stream>
 
#include <span>
#include <vector>
 
namespace CUDF_EXPORT cudf {
 
size_type state_null_count(mask_state state, size_type size);
 
std::size_t bitmask_allocation_size_bytes(size_type number_of_bits,
                                          std::size_t padding_boundary = 64);
 
size_type num_bitmask_words(size_type number_of_bits);
 
rmm::device_buffer create_null_mask(
  size_type size,
  mask_state state,
  cuda::stream_ref stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
void set_null_mask(bitmask_type* bitmask,
                   size_type begin_bit,
                   size_type end_bit,
                   bool valid,
                   cuda::stream_ref stream = cudf::get_default_stream());
 
void set_null_masks_safe(cudf::host_span<bitmask_type*> bitmasks,
                         cudf::host_span<size_type const> begin_bits,
                         cudf::host_span<size_type const> end_bits,
                         cudf::host_span<bool const> valids,
                         cuda::stream_ref stream = cudf::get_default_stream());
 
void set_null_masks_unsafe(cudf::host_span<bitmask_type*> bitmasks,
                           cudf::host_span<size_type const> begin_bits,
                           cudf::host_span<size_type const> end_bits,
                           cudf::host_span<bool const> valids,
                           cuda::stream_ref stream = cudf::get_default_stream());
 
rmm::device_buffer copy_bitmask(
  bitmask_type const* mask,
  size_type begin_bit,
  size_type end_bit,
  cuda::stream_ref stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
rmm::device_buffer copy_bitmask(
  column_view const& view,
  cuda::stream_ref stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
std::pair<rmm::device_buffer, size_type> bitmask_and(
  table_view const& view,
  cuda::stream_ref stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
std::pair<rmm::device_buffer, size_type> bitmask_and(
  host_span<bitmask_type const* const> masks,
  host_span<size_type const> begin_bits,
  size_type mask_size,
  cuda::stream_ref stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
std::pair<std::vector<std::unique_ptr<rmm::device_buffer>>, std::vector<size_type>>
segmented_bitmask_and(host_span<column_view const> colviews,
                      host_span<size_type const> segment_offsets,
                      cuda::stream_ref stream           = cudf::get_default_stream(),
                      rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
std::pair<std::vector<std::unique_ptr<rmm::device_buffer>>, std::vector<size_type>>
segmented_bitmask_and(host_span<bitmask_type const* const> masks,
                      host_span<size_type const> segment_offsets,
                      size_type mask_size_bits,
                      cuda::stream_ref stream           = cudf::get_default_stream(),
                      rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
std::pair<rmm::device_buffer, size_type> bitmask_or(
  table_view const& view,
  cuda::stream_ref stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
size_type null_count(bitmask_type const* bitmask,
                     size_type start,
                     size_type stop,
                     cuda::stream_ref stream = cudf::get_default_stream());
 
std::vector<size_type> batch_null_count(host_span<bitmask_type const* const> bitmasks,
                                        size_type start,
                                        size_type stop,
                                        cuda::stream_ref stream = cudf::get_default_stream());
 
std::vector<size_type> segmented_valid_count(bitmask_type const* bitmask,
                                             std::span<size_type const> indices,
                                             cuda::stream_ref stream = cudf::get_default_stream());
 
std::vector<size_type> segmented_null_count(bitmask_type const* bitmask,
                                            std::span<size_type const> indices,
                                            cuda::stream_ref stream = cudf::get_default_stream());
 
size_type index_of_first_set_bit(bitmask_type const* bitmask,
                                 size_type start,
                                 size_type stop,
                                 cuda::stream_ref stream = cudf::get_default_stream());
  // end of group
}  // namespace CUDF_EXPORT cudf