Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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  *
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
26 namespace cudf {
38  public:
47  ~strings_column_view() = default;
61  static constexpr size_type offsets_column_index{0};
67  using column_view::offset;
68  using column_view::size;
70  using offset_iterator = size_type const*;
71  using chars_iterator = char const*;
78  [[nodiscard]] column_view parent() const;
86  [[nodiscard]] column_view offsets() const;
95  [[nodiscard]] offset_iterator offsets_begin() const;
104  [[nodiscard]] offset_iterator offsets_end() const;
113  [[deprecated]] [[nodiscard]] column_view chars(
125  [[nodiscard]] size_type chars_size(rmm::cuda_stream_view stream) const noexcept;
149  [[nodiscard]] chars_iterator chars_end(rmm::cuda_stream_view stream) const;
150 };
153 namespace strings {
154 } // namespace strings
155  // end of group
157 } // namespace cudf
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
size_type null_count() const
Returns the count of null elements.
size_type size() const noexcept
Returns the number of elements in the column.
size_type offset() const noexcept
Returns the index of the first element relative to the base memory allocation, i.e....
bool has_nulls() const
Indicates if the column contains null elements, i.e., null_count() > 0
bitmask_type const * null_mask() const noexcept
Returns raw pointer to the underlying bitmask allocation.
bool is_empty() const noexcept
Returns true if size() returns zero, or false otherwise.
Given a column-view of strings type, an instance of this class provides a wrapper on this compound co...
strings_column_view(strings_column_view &&)=default
Move constructor.
column_view chars(rmm::cuda_stream_view stream=cudf::get_default_stream()) const
Returns the internal column of chars.
size_type const * offset_iterator
offsets iterator type
char const * chars_iterator
character iterator type
strings_column_view(column_view strings_column)
Construct a new strings column view object from a column view.s.
column_view parent() const
Returns the parent column.
chars_iterator chars_begin(rmm::cuda_stream_view) const
Return an iterator for the chars child column.
size_type chars_size(rmm::cuda_stream_view stream) const noexcept
Returns the number of bytes in the chars child column.
static constexpr size_type offsets_column_index
Child index of the offsets column.
strings_column_view(strings_column_view const &)=default
Copy constructor.
strings_column_view & operator=(strings_column_view const &)=default
Copy assignment operator.
offset_iterator offsets_begin() const
Return an iterator for the offsets child column.
chars_iterator chars_end(rmm::cuda_stream_view stream) const
Return an end iterator for the offsets child column.
strings_column_view & operator=(strings_column_view &&)=default
Move assignment operator.
offset_iterator offsets_end() const
Return an end iterator for the offsets child column.
column_view offsets() const
Returns the internal column of offsets.
column view class definitions
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:93
cuDF interfaces
Definition: aggregation.hpp:34