Public Types | Public Member Functions | Static Public Attributes | List of all members
cudf::strings_column_view Class Reference

Given a column-view of strings type, an instance of this class provides a wrapper on this compound column for strings operations. More...

#include <strings_column_view.hpp>

Inheritance diagram for cudf::strings_column_view:
cudf::column_view

Public Types

using offset_iterator = offset_type const *
 
using chars_iterator = char const *
 

Public Member Functions

 strings_column_view (column_view strings_column)
 
 strings_column_view (strings_column_view &&strings_view)=default
 
 strings_column_view (const strings_column_view &strings_view)=default
 
strings_column_viewoperator= (strings_column_view const &)=default
 
strings_column_viewoperator= (strings_column_view &&)=default
 
column_view parent () const
 Returns the parent column.
 
column_view offsets () const
 Returns the internal column of offsets. More...
 
offset_iterator offsets_begin () const
 Return an iterator for the offsets child column. More...
 
offset_iterator offsets_end () const
 Return an end iterator for the offsets child column. More...
 
column_view chars () const
 Returns the internal column of chars. More...
 
size_type chars_size () const noexcept
 Returns the number of bytes in the chars child column. More...
 
chars_iterator chars_begin () const
 Return an iterator for the chars child column. More...
 
chars_iterator chars_end () const
 Return an end iterator for the offsets child column. More...
 

Static Public Attributes

static constexpr size_type offsets_column_index {0}
 
static constexpr size_type chars_column_index {1}
 

Detailed Description

Given a column-view of strings type, an instance of this class provides a wrapper on this compound column for strings operations.

Definition at line 36 of file strings_column_view.hpp.

Member Function Documentation

◆ chars()

column_view cudf::strings_column_view::chars ( ) const

Returns the internal column of chars.

Exceptions
cudf::logicerror if this is an empty column

◆ chars_begin()

chars_iterator cudf::strings_column_view::chars_begin ( ) const

Return an iterator for the chars child column.

This does not apply the offset of the parent. The offsets child must be used to properly address the char bytes.

For example, to access the first character of string i (accounting for a sliced column offset) use: chars_begin()[offsets_begin()[i]].

Returns
Iterator pointing to the first char byte.

◆ chars_end()

chars_iterator cudf::strings_column_view::chars_end ( ) const

Return an end iterator for the offsets child column.

This does not apply the offset of the parent. The offsets child must be used to properly address the char bytes.

Returns
Iterator pointing 1 past the last char byte.

◆ chars_size()

size_type cudf::strings_column_view::chars_size ( ) const
noexcept

Returns the number of bytes in the chars child column.

This accounts for empty columns but does not reflect a sliced parent column view (i.e.: non-zero offset or reduced row count).

◆ offsets()

column_view cudf::strings_column_view::offsets ( ) const

Returns the internal column of offsets.

Exceptions
cudf::logicerror if this is an empty column

◆ offsets_begin()

offset_iterator cudf::strings_column_view::offsets_begin ( ) const

Return an iterator for the offsets child column.

This automatically applies the offset of the parent.

Returns
Iterator pointing to the first offset value.

◆ offsets_end()

offset_iterator cudf::strings_column_view::offsets_end ( ) const

Return an end iterator for the offsets child column.

This automatically applies the offset of the parent.

Returns
Iterator pointing 1 past the last offset value.

The documentation for this class was generated from the following file: