cudf::dictionary_column_view Class Reference

A wrapper class for operations on a dictionary column. More...

#include <dictionary_column_view.hpp>

Inheritance diagram for cudf::dictionary_column_view:

Public Member Functions
	dictionary_column_view (column_view const &dictionary_column)
	Construct a new dictionary column view object from a column view. More...
	dictionary_column_view (dictionary_column_view &&)=default
	Move constructor.
	dictionary_column_view (dictionary_column_view const &)=default
	Copy constructor.
dictionary_column_view &	operator= (dictionary_column_view const &)=default
	Move assignment operator. More...
dictionary_column_view &	operator= (dictionary_column_view &&)=default
	Copy assignment operator. More...
column_view	parent () const noexcept
	Returns the parent column. More...
column_view	indices () const noexcept
	Returns the column of indices. More...
column_view	get_indices_annotated () const noexcept
	Returns a column_view combining the indices data with offset, size, and nulls from the parent. More...
column_view	keys () const noexcept
	Returns the column of keys. More...
data_type	keys_type () const noexcept
	Returns the cudf::data_type of the keys child column. More...
size_type	keys_size () const noexcept
	Returns the number of rows in the keys column. More...

Static Public Attributes
static constexpr size_type	indices_column_index {0}
	Index of the indices column of the dictionary column.
static constexpr size_type	keys_column_index {1}
	Index of the keys column of the dictionary column.

Detailed Description

A wrapper class for operations on a dictionary column.

A dictionary column contains a set of keys and a column of indices. The keys are a sorted set of unique values for the column. The indices represent the corresponding positions of each element's value in the keys.

Definition at line 39 of file dictionary_column_view.hpp.

Constructor & Destructor Documentation

dictionary_column_view()

cudf::dictionary_column_view::dictionary_column_view

(

column_view const &

dictionary_column

)

Construct a new dictionary column view object from a column view.

Parameters

dictionary_column

The column view to wrap

Member Function Documentation

get_indices_annotated()

column_view cudf::dictionary_column_view::get_indices_annotated ( ) const

noexcept

Returns a column_view combining the indices data with offset, size, and nulls from the parent.

Returns

A sliced indices column view with nulls from the parent

indices()

column_view cudf::dictionary_column_view::indices ( ) const

noexcept

Returns the column of indices.

Returns

The indices column

keys()

column_view cudf::dictionary_column_view::keys ( ) const

noexcept

Returns the column of keys.

Returns

The keys column

keys_size()

size_type cudf::dictionary_column_view::keys_size ( ) const

noexcept

Returns the number of rows in the keys column.

Returns

The number of rows in the keys column

keys_type()

data_type cudf::dictionary_column_view::keys_type ( ) const

noexcept

Returns the cudf::data_type of the keys child column.

Returns

The cudf::data_type of the keys child column

operator=() [1/2]

dictionary_column_view& cudf::dictionary_column_view::operator= ( dictionary_column_view &&  )

default

Copy assignment operator.

Returns

The reference to this dictionary column

operator=() [2/2]

dictionary_column_view& cudf::dictionary_column_view::operator= ( dictionary_column_view const &  )

default

Move assignment operator.

Returns

The reference to this dictionary column

parent()

column_view cudf::dictionary_column_view::parent ( ) const

noexcept

Returns the parent column.

Returns

The parent column

---

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

• dictionary_column_view.hpp