lists/combine.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2024, NVIDIA CORPORATION.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
18 #include <cudf/column/column.hpp>
20 #include <cudf/utilities/export.hpp>
22 
23 namespace CUDF_EXPORT cudf {
24 
26 namespace lists {
37 enum class concatenate_null_policy { IGNORE, NULLIFY_OUTPUT_ROW };
38 
65 std::unique_ptr<column> concatenate_rows(
66  table_view const& input,
67  concatenate_null_policy null_policy = concatenate_null_policy::IGNORE,
70 
96 std::unique_ptr<column> concatenate_list_elements(
97  column_view const& input,
98  concatenate_null_policy null_policy = concatenate_null_policy::IGNORE,
101  // end of group
103 } // namespace lists
104 } // 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...
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:200
Class definition for cudf::column.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
std::unique_ptr< column > concatenate_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=cudf::get_current_device_resource_ref())
Concatenating multiple lists on the same row of a lists column into a single list.
concatenate_null_policy
Flag to specify whether a null list element will be ignored from concatenation, or the entire concate...
std::unique_ptr< column > concatenate_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=cudf::get_current_device_resource_ref())
Row-wise concatenating multiple lists columns into a single lists column.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
null_policy
Enum to specify whether to include nulls or exclude nulls.
Definition: types.hpp:126
Class definition for cudf::lists_column_view.
cuDF interfaces
Definition: aggregation.hpp:35