Enumerations | Functions
cudf::lists Namespace Reference

Lists column APIs. More...

Enumerations

enum class  concatenate_null_policy { IGNORE , NULLIFY_OUTPUT_ROW }
 Flag to specify whether a null list element will be ignored from concatenation, or the entire concatenation result involving null list elements will be a null element.
 
enum class  duplicate_find_option : int32_t { FIND_FIRST = 0 , FIND_LAST }
 Option to choose whether index_of() returns the first or last match of a search key in a list row. More...
 

Functions

std::unique_ptr< columnconcatenate_rows (table_view const &input, concatenate_null_policy null_policy=concatenate_null_policy::IGNORE, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Row-wise concatenating multiple lists columns into a single lists column. More...
 
std::unique_ptr< columnconcatenate_list_elements (column_view const &input, concatenate_null_policy null_policy=concatenate_null_policy::IGNORE, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Concatenating multiple lists on the same row of a lists column into a single list. More...
 
std::unique_ptr< columncontains (cudf::lists_column_view const &lists, cudf::scalar const &search_key, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a column of bool values indicating whether the specified scalar is an element of each row of a list column. More...
 
std::unique_ptr< columncontains (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=rmm::mr::get_current_device_resource())
 Create a column of bool values indicating whether the list rows of the first column contain the corresponding values in the second column. More...
 
std::unique_ptr< columncontains_nulls (cudf::lists_column_view const &lists, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a column of bool values indicating whether each row in the lists column contains at least one null element. More...
 
std::unique_ptr< columnindex_of (cudf::lists_column_view const &lists, cudf::scalar const &search_key, 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=rmm::mr::get_current_device_resource())
 Create a column of values indicating the position of a search key within each list row in the lists column. More...
 
std::unique_ptr< columnindex_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=rmm::mr::get_current_device_resource())
 Create a column of values indicating the position of a search key row within the corresponding list row in the lists column. More...
 
std::unique_ptr< columncount_elements (lists_column_view const &input, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Returns a numeric column containing the number of rows in each list element in the given lists column. More...
 
std::unique_ptr< columnextract_list_element (lists_column_view const &lists_column, size_type index, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a column where each row is the element at position index from the corresponding sublist in the input lists_column. More...
 
std::unique_ptr< columnextract_list_element (lists_column_view const &lists_column, column_view const &indices, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a column where each row is a single element from the corresponding sublist in the input lists_column, selected using indices from the indices column. More...
 
std::unique_ptr< columnsequences (column_view const &starts, column_view const &sizes, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a lists column in which each row contains a sequence of values specified by a tuple of (start, size) parameters. More...
 
std::unique_ptr< columnsequences (column_view const &starts, column_view const &steps, column_view const &sizes, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a lists column in which each row contains a sequence of values specified by a tuple of (start, step, size) parameters. More...
 
std::unique_ptr< columnsegmented_gather (lists_column_view const &source_column, lists_column_view const &gather_map_list, out_of_bounds_policy bounds_policy=out_of_bounds_policy::DONT_CHECK, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Segmented gather of the elements within a list element in each row of a list column. More...
 
std::unique_ptr< columnreverse (lists_column_view const &input, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Reverse the element order within each list of the input column. More...
 
std::unique_ptr< columnhave_overlap (lists_column_view const &lhs, lists_column_view const &rhs, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Check if lists at each row of the given lists columns overlap. More...
 
std::unique_ptr< columnintersect_distinct (lists_column_view const &lhs, lists_column_view const &rhs, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a lists column of distinct elements common to two input lists columns. More...
 
std::unique_ptr< columnunion_distinct (lists_column_view const &lhs, lists_column_view const &rhs, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a lists column of distinct elements found in either of two input lists columns. More...
 
std::unique_ptr< columndifference_distinct (lists_column_view const &lhs, lists_column_view const &rhs, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a lists column of distinct elements found only in the left input column. More...
 
std::unique_ptr< columnsort_lists (lists_column_view const &source_column, order column_order, null_order null_precedence, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Segmented sort of the elements within a list in each row of a list column. More...
 
std::unique_ptr< columnstable_sort_lists (lists_column_view const &source_column, order column_order, null_order null_precedence, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Segmented sort of the elements within a list in each row of a list column using stable sort. More...
 
std::unique_ptr< columnapply_boolean_mask (lists_column_view const &input, lists_column_view const &boolean_mask, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Filters elements in each row of input LIST column using boolean_mask LIST of booleans as a mask. More...
 
std::unique_ptr< columndistinct (lists_column_view const &input, null_equality nulls_equal=null_equality::EQUAL, nan_equality nans_equal=nan_equality::ALL_EQUAL, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
 Create a new list column without duplicate elements in each list. More...
 

Detailed Description

Lists column APIs.