Given a column-view of lists type, an instance of this class provides a wrapper on this compound column for list operations.
More...
#include <lists_column_view.hpp>
Given a column-view of lists type, an instance of this class provides a wrapper on this compound column for list operations.
Definition at line 39 of file lists_column_view.hpp.
◆ lists_column_view()
cudf::lists_column_view::lists_column_view |
( |
column_view const & |
lists_column | ) |
|
Construct a new lists column view object from a column view.
- Parameters
-
lists_column | The column view to wrap |
◆ child()
Returns the internal child column.
- Exceptions
-
- Returns
- The internal child column
◆ child_begin()
auto cudf::column_view::child_begin |
|
inlinenoexcept |
Returns iterator to the beginning of the ordered sequence of child column-views.
- Returns
- An iterator to a
column_view
referencing the first child column
Definition at line 402 of file column_view.hpp.
◆ child_end()
auto cudf::column_view::child_end |
|
inlinenoexcept |
Returns iterator to the end of the ordered sequence of child column-views.
- Returns
- An iterator to a
column_view
one past the end of the child columns
Definition at line 409 of file column_view.hpp.
◆ get_sliced_child()
column_view cudf::lists_column_view::get_sliced_child |
( |
rmm::cuda_stream_view |
stream | ) |
const |
Returns the internal child column, applying any offset from the root.
Slice/split offset values are only stored at the root level of a list column. So when doing computations on them, we need to apply that offset to the child columns when recursing. Most functions operating in a recursive manner on lists columns should be using get_sliced_child()
instead of child()
.
- Exceptions
-
- Parameters
-
stream | CUDA stream used for device memory operations and kernel launches |
- Returns
- A sliced child column view
◆ offsets()
Returns the internal column of offsets.
- Exceptions
-
- Returns
- The internal column of offsets
◆ offsets_begin()
Return first offset (accounting for column offset)
- Returns
- Pointer to the first offset
Definition at line 118 of file lists_column_view.hpp.
◆ offsets_end()
Return pointer to the position that is one past the last offset.
This function return the position that is one past the last offset of the lists column. Since the current lists column may be a sliced column, this offsets_end() iterator should not be computed using the size of the offsets() child column, which is also the offsets of the entire original (non-sliced) lists column.
- Returns
- Pointer to one past the last offset
Definition at line 133 of file lists_column_view.hpp.
◆ operator=() [1/2]
Move assignment operator.
- Returns
- The reference to this lists column
◆ operator=() [2/2]
Copy assignment operator.
- Returns
- The reference to this lists column
◆ parent()
Returns the parent column.
- Returns
- The parent column
The documentation for this class was generated from the following file: