Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PointKernel committed Nov 10, 2021
1 parent bf1bca0 commit 9a0f562
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
6 changes: 3 additions & 3 deletions cpp/include/cudf/detail/null_mask.cuh
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ namespace detail {
* @param source_begin_bits Array of offsets into corresponding @p source masks.
* Must be same size as source array
* @param source_size_bits Number of bits in each mask in @p source
* @param count Pointer to valid-bit counter
* @param count Pointer to counter of set bits
*/
template <int block_size, typename Binop>
__global__ void offset_bitmask_binop(Binop op,
Expand Down Expand Up @@ -123,7 +123,7 @@ std::pair<rmm::device_buffer, size_type> bitmask_binop(

/**
* @brief Performs a merge of the specified bitmasks using the binary operator
* provided, writes in place to destination and returns count of valid bits
* provided, writes in place to destination and returns count of set bits
*
* @param[in] op The binary operator used to combine the bitmasks
* @param[out] dest_mask Destination to which the merged result is written
Expand All @@ -132,7 +132,7 @@ std::pair<rmm::device_buffer, size_type> bitmask_binop(
* @param[in] mask_size_bits The number of bits to be ANDed in each mask
* @param[in] stream CUDA stream used for device memory operations and kernel launches
* @param[in] mr Device memory resource used to allocate the returned device_buffer
* @return size_type Count of valid bits
* @return size_type Count of set bits
*/
template <typename Binop>
size_type inplace_bitmask_binop(
Expand Down
10 changes: 6 additions & 4 deletions cpp/include/cudf/null_mask.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -202,28 +202,30 @@ rmm::device_buffer copy_bitmask(
rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());

/**
* @brief Returns a pair of bitwise AND of the bitmasks of columns of a table and count of null bits
* @brief Performs bitwise AND of the bitmasks of columns of a table. Returns
* a pair of resulting mask and count of unset bits.
*
* If any of the columns isn't nullable, it is considered all valid.
* If no column in the table is nullable, an empty bitmask is returned.
*
* @param view The table of columns
* @param mr Device memory resource used to allocate the returned device_buffer
* @return A pair of resulting bitmask and count of null bits
* @return A pair of resulting bitmask and count of unset bits
*/
std::pair<rmm::device_buffer, size_type> bitmask_and(
table_view const& view,
rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());

/**
* @brief Returns a pair of bitwise OR of the bitmasks of columns of a table and count of null bits
* @brief Performs bitwise OR of the bitmasks of columns of a table. Returns
* a pair of resulting mask and count of unset bits.
*
* If any of the columns isn't nullable, it is considered all valid.
* If no column in the table is nullable, an empty bitmask is returned.
*
* @param view The table of columns
* @param mr Device memory resource used to allocate the returned device_buffer
* @return A pair of resulting bitmask and count of null bits
* @return A pair of resulting bitmask and count of unset bits
*/
std::pair<rmm::device_buffer, size_type> bitmask_or(
table_view const& view,
Expand Down

0 comments on commit 9a0f562

Please sign in to comment.