null_mask.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2019-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/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 <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,
  rmm::cuda_stream_view 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,
                   rmm::cuda_stream_view stream = cudf::get_default_stream());
 
[[deprecated]] void set_null_masks(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,
                                   rmm::cuda_stream_view 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,
                         rmm::cuda_stream_view 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,
                           rmm::cuda_stream_view stream = cudf::get_default_stream());
 
rmm::device_buffer copy_bitmask(
  bitmask_type const* mask,
  size_type begin_bit,
  size_type end_bit,
  rmm::cuda_stream_view 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,
  rmm::cuda_stream_view 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,
  rmm::cuda_stream_view 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,
                      rmm::cuda_stream_view 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,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = cudf::get_current_device_resource_ref());
 
cudf::size_type null_count(bitmask_type const* bitmask,
                           size_type start,
                           size_type stop,
                           rmm::cuda_stream_view stream = cudf::get_default_stream());  // end of group
}  // namespace CUDF_EXPORT cudf