strings/combine.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2024, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#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/table/table_view.hpp>
 
#include <rmm/mr/device/per_device_resource.hpp>
#include <rmm/resource_ref.hpp>
 
namespace CUDF_EXPORT cudf {
namespace strings {
enum class separator_on_nulls {
  YES,  
  NO    
};
 
enum class output_if_empty_list {
  EMPTY_STRING,  
  NULL_ELEMENT   
};
 
std::unique_ptr<column> join_strings(
  strings_column_view const& input,
  string_scalar const& separator    = string_scalar(""),
  string_scalar const& narep        = string_scalar("", false),
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> concatenate(
  table_view const& strings_columns,
  strings_column_view const& separators,
  string_scalar const& separator_narep = string_scalar("", false),
  string_scalar const& col_narep       = string_scalar("", false),
  separator_on_nulls separate_nulls    = separator_on_nulls::YES,
  rmm::cuda_stream_view stream         = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr    = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> concatenate(
  table_view const& strings_columns,
  string_scalar const& separator    = string_scalar(""),
  string_scalar const& narep        = string_scalar("", false),
  separator_on_nulls separate_nulls = separator_on_nulls::YES,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> join_list_elements(
  lists_column_view const& lists_strings_column,
  strings_column_view const& separators,
  string_scalar const& separator_narep   = string_scalar("", false),
  string_scalar const& string_narep      = string_scalar("", false),
  separator_on_nulls separate_nulls      = separator_on_nulls::YES,
  output_if_empty_list empty_list_policy = output_if_empty_list::EMPTY_STRING,
  rmm::cuda_stream_view stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr      = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> join_list_elements(
  lists_column_view const& lists_strings_column,
  string_scalar const& separator         = string_scalar(""),
  string_scalar const& narep             = string_scalar("", false),
  separator_on_nulls separate_nulls      = separator_on_nulls::YES,
  output_if_empty_list empty_list_policy = output_if_empty_list::EMPTY_STRING,
  rmm::cuda_stream_view stream           = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr      = rmm::mr::get_current_device_resource());
  // end of doxygen group
}  // namespace strings
}  // namespace CUDF_EXPORT cudf