contains.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2021-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
7 #include <cudf/column/column.hpp>
9 #include <cudf/utilities/export.hpp>
11 
12 namespace CUDF_EXPORT cudf {
13 namespace lists {
39 std::unique_ptr<column> contains(
40  cudf::lists_column_view const& lists,
41  cudf::scalar const& search_key,
44 
63 std::unique_ptr<column> contains(
64  cudf::lists_column_view const& lists,
65  cudf::column_view const& search_keys,
68 
86 std::unique_ptr<column> contains_nulls(
87  cudf::lists_column_view const& lists,
90 
95 enum class duplicate_find_option : int32_t {
96  FIND_FIRST = 0,
97  FIND_LAST
98 };
99 
128 std::unique_ptr<column> index_of(
129  cudf::lists_column_view const& lists,
130  cudf::scalar const& search_key,
131  duplicate_find_option find_option = duplicate_find_option::FIND_FIRST,
134 
165 std::unique_ptr<column> index_of(
166  cudf::lists_column_view const& lists,
167  cudf::column_view const& search_keys,
168  duplicate_find_option find_option = duplicate_find_option::FIND_FIRST,
171  // end of group
173 } // namespace lists
174 } // namespace CUDF_EXPORT cudf
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Given a column-view of lists type, an instance of this class provides a wrapper on this compound colu...
An owning class to represent a singular value.
Definition: scalar.hpp:41
Class definition for cudf::column.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
std::unique_ptr< column > index_of(cudf::lists_column_view const &lists, cudf::column_view const &search_keys, duplicate_find_option find_option=duplicate_find_option::FIND_FIRST, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a column of values indicating the position of a search key row within the corresponding list r...
std::unique_ptr< column > contains(cudf::lists_column_view const &lists, cudf::column_view const &search_keys, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a column of bool values indicating whether the list rows of the first column contain the corre...
duplicate_find_option
Option to choose whether index_of() returns the first or last match of a search key in a list row.
Definition: contains.hpp:95
std::unique_ptr< column > contains_nulls(cudf::lists_column_view const &lists, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Create a column of bool values indicating whether each row in the lists column contains at least one ...
@ FIND_FIRST
Finds first instance of a search key in a list row.
@ FIND_LAST
Finds last instance of a search key in a list row.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::resource_ref< cuda::mr::device_accessible > device_async_resource_ref
Class definition for cudf::lists_column_view.
APIs for getting and setting the current device memory resource.
cuDF interfaces
Definition: host_udf.hpp:26