libcudf: convert_lists.hpp Source File

 /*

  * SPDX-FileCopyrightText: Copyright (c) 2021-2024, NVIDIA CORPORATION.

  * SPDX-License-Identifier: Apache-2.0

  */

 #pragma once


 #include <cudf/column/column.hpp>

 #include <cudf/lists/lists_column_view.hpp>

 #include <cudf/scalar/scalar.hpp>

 #include <cudf/strings/strings_column_view.hpp>

 #include <cudf/utilities/memory_resource.hpp>


 namespace CUDF_EXPORT cudf {

 namespace strings {

 std::unique_ptr<column> format_list_column(

   lists_column_view const& input,

   string_scalar const& na_rep           = string_scalar(""),

   strings_column_view const& separators = strings_column_view(column_view{

     data_type{type_id::STRING}, 0, nullptr, nullptr, 0}),

   rmm::cuda_stream_view stream          = cudf::get_default_stream(),

   rmm::device_async_resource_ref mr     = cudf::get_current_device_resource_ref());

   // end of doxygen group

 }  // namespace strings

 }  // namespace CUDF_EXPORT cudf

cudf::column_view
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Definition: column_view.hpp:316

cudf::data_type
Indicator for the logical data type of an element in a column.
Definition: types.hpp:238

cudf::lists_column_view
Given a column-view of lists type, an instance of this class provides a wrapper on this compound colu...
Definition: lists_column_view.hpp:29

cudf::string_scalar
An owning class to represent a string in device memory.
Definition: scalar.hpp:410

cudf::strings_column_view
Given a column-view of strings type, an instance of this class provides a wrapper on this compound co...
Definition: strings_column_view.hpp:27

rmm::cuda_stream_view

column.hpp
Class definition for cudf::column.

cudf::get_default_stream
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.

cudf::get_current_device_resource_ref
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
Definition: memory_resource.hpp:40

device_async_resource_ref
detail::cccl_async_resource_ref< cuda::mr::resource_ref< cuda::mr::device_accessible > > device_async_resource_ref

cudf::strings::format_list_column
std::unique_ptr< column > format_list_column(lists_column_view const &input, string_scalar const &na_rep=string_scalar(""), strings_column_view const &separators=strings_column_view(column_view{ data_type{type_id::STRING}, 0, nullptr, nullptr, 0}), rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Convert a list column of strings into a formatted strings column.

lists_column_view.hpp
Class definition for cudf::lists_column_view.

memory_resource.hpp

cudf
cuDF interfaces
Definition: host_udf.hpp:26

scalar.hpp
Class definitions for cudf::scalar.

strings_column_view.hpp
Class definition for cudf::strings_column_view.