dictionary_column_view.hpp
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2020-2024, NVIDIA CORPORATION.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
8 
14 namespace CUDF_EXPORT cudf {
29  public:
35  dictionary_column_view(column_view const& dictionary_column);
38  ~dictionary_column_view() override = default;
39 
46 
53 
55  static constexpr size_type indices_column_index{0};
57  static constexpr size_type keys_column_index{1};
58 
60  using column_view::is_empty;
62  using column_view::null_mask;
63  using column_view::offset;
64  using column_view::size;
65 
71  [[nodiscard]] column_view parent() const noexcept;
72 
78  [[nodiscard]] column_view indices() const noexcept;
79 
86  [[nodiscard]] column_view get_indices_annotated() const noexcept;
87 
93  [[nodiscard]] column_view keys() const noexcept;
94 
100  [[nodiscard]] data_type keys_type() const noexcept;
101 
107  [[nodiscard]] size_type keys_size() const noexcept;
108 }; // end of group
110 
112 namespace dictionary { // defined here for doxygen output
113 }
114 
115 } // namespace CUDF_EXPORT cudf
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
Indicator for the logical data type of an element in a column.
Definition: types.hpp:238
A wrapper class for operations on a dictionary column.
dictionary_column_view(dictionary_column_view &&)=default
Move constructor.
dictionary_column_view & operator=(dictionary_column_view const &)=default
Move assignment operator.
dictionary_column_view(dictionary_column_view const &)=default
Copy constructor.
dictionary_column_view(column_view const &dictionary_column)
Construct a new dictionary column view object from a column view.
dictionary_column_view & operator=(dictionary_column_view &&)=default
Copy assignment operator.
column_view parent() const noexcept
Returns the parent column.
column view class definitions
cudf::size_type null_count(bitmask_type const *bitmask, size_type start, size_type stop, rmm::cuda_stream_view stream=cudf::get_default_stream())
Given a validity bitmask, counts the number of null elements (unset bits) in the range [start,...
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:84
cuDF interfaces
Definition: host_udf.hpp:26
bool has_nulls(table_view const &view)
Returns True if the table has nulls in any of its columns.