capitalize.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-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>
19 #include <cudf/scalar/scalar.hpp>
22 
23 #include <rmm/mr/device/per_device_resource.hpp>
24 #include <rmm/resource_ref.hpp>
25 
26 namespace cudf {
27 namespace strings {
62 std::unique_ptr<column> capitalize(
63  strings_column_view const& input,
64  string_scalar const& delimiters = string_scalar("", true, cudf::get_default_stream()),
65  rmm::cuda_stream_view stream = cudf::get_default_stream(),
66  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
67 
95 std::unique_ptr<column> title(
96  strings_column_view const& input,
98  rmm::cuda_stream_view stream = cudf::get_default_stream(),
99  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
100 
125 std::unique_ptr<column> is_title(
126  strings_column_view const& input,
127  rmm::cuda_stream_view stream = cudf::get_default_stream(),
128  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
129  // end of doxygen group
131 } // namespace strings
132 } // namespace cudf
An owning class to represent a string in device memory.
Definition: scalar.hpp:431
Given a column-view of strings type, an instance of this class provides a wrapper on this compound co...
Class definition for cudf::column.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
std::unique_ptr< column > capitalize(strings_column_view const &input, string_scalar const &delimiters=string_scalar("", true, cudf::get_default_stream()), rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Returns a column of capitalized strings.
std::unique_ptr< column > is_title(strings_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())
Checks if the strings in the input column are title formatted.
std::unique_ptr< column > title(strings_column_view const &input, string_character_types sequence_type=string_character_types::ALPHA, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=rmm::mr::get_current_device_resource())
Modifies first character of each word to upper-case and lower-cases the rest.
string_character_types
Character type values. These types can be or'd to check for any combination of types.
@ ALPHA
all alphabetic characters
cuDF interfaces
Definition: aggregation.hpp:34
Class definitions for cudf::scalar.
Class definition for cudf::strings_column_view.