char_types.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2021, 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/scalar/scalar.hpp>
#include <cudf/strings/strings_column_view.hpp>
 
namespace cudf {
namespace strings {
enum string_character_types : uint32_t {
  DECIMAL    = 1 << 0,                             
  NUMERIC    = 1 << 1,                             
  DIGIT      = 1 << 2,                             
  ALPHA      = 1 << 3,                             
  SPACE      = 1 << 4,                             
  UPPER      = 1 << 5,                             
  LOWER      = 1 << 6,                             
  ALPHANUM   = DECIMAL | NUMERIC | DIGIT | ALPHA,  
  CASE_TYPES = UPPER | LOWER,                      
  ALL_TYPES  = ALPHANUM | CASE_TYPES | SPACE       
};
 
string_character_types operator|(string_character_types lhs, string_character_types rhs);
 
string_character_types& operator|=(string_character_types& lhs, string_character_types rhs);
 
std::unique_ptr<column> all_characters_of_type(
  strings_column_view const& strings,
  string_character_types types,
  string_character_types verify_types = string_character_types::ALL_TYPES,
  rmm::mr::device_memory_resource* mr = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> filter_characters_of_type(
  strings_column_view const& strings,
  string_character_types types_to_remove,
  string_scalar const& replacement     = string_scalar(""),
  string_character_types types_to_keep = string_character_types::ALL_TYPES,
  rmm::mr::device_memory_resource* mr  = rmm::mr::get_current_device_resource());
  // end of doxygen group
}  // namespace strings
}  // namespace cudf