table_device_view.cuh
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2019-2026, NVIDIA CORPORATION.
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #pragma once
6 
9 #include <cudf/types.hpp>
11 
12 #include <rmm/cuda_stream_view.hpp>
13 #include <rmm/device_buffer.hpp>
14 
15 #include <cassert>
16 #include <memory>
17 
23 namespace CUDF_EXPORT cudf {
24 namespace detail {
25 
42 template <typename ColumnDeviceView, typename HostTableView>
44  public:
45  table_device_view_base() = delete;
46  ~table_device_view_base() = default;
61 
67  __device__ ColumnDeviceView* begin() const noexcept { return _columns; }
68 
77  __device__ ColumnDeviceView* end() const noexcept { return _columns + _num_columns; }
78 
85  __device__ ColumnDeviceView const& column(size_type column_index) const noexcept
86  {
87  assert(column_index >= 0);
88  assert(column_index < _num_columns);
89  return _columns[column_index];
90  }
91 
98  __device__ ColumnDeviceView& column(size_type column_index) noexcept
99  {
100  assert(column_index >= 0);
101  assert(column_index < _num_columns);
102  return _columns[column_index];
103  }
104 
110  [[nodiscard]] __host__ __device__ size_type num_columns() const noexcept { return _num_columns; }
111 
117  [[nodiscard]] __host__ __device__ size_type num_rows() const noexcept { return _num_rows; }
118 
125  void destroy();
126 
127  private:
128  ColumnDeviceView* _columns{};
129  size_type _num_rows{};
130  size_type _num_columns{};
131 
132  protected:
140  table_device_view_base(HostTableView source_view, ColumnDeviceView* columns);
141 };
142 } // namespace detail
143 
147 class table_device_view : public detail::table_device_view_base<column_device_view, table_view> {
148  public:
163  static std::unique_ptr<table_device_view, std::function<void(table_device_view*)>> create(
165 
166  private:
167  table_device_view(table_view source_view, column_device_view* columns);
168 };
169 
176  : public detail::table_device_view_base<mutable_column_device_view, mutable_table_view> {
177  public:
192  static std::unique_ptr<mutable_table_device_view, std::function<void(mutable_table_device_view*)>>
194 
195  private:
197 };
198 
208 template <typename ColumnDeviceView, typename HostTableView>
209 std::pair<std::unique_ptr<rmm::device_buffer>, ColumnDeviceView*> create_column_device_views(
210  HostTableView source_view, rmm::cuda_stream_view stream);
211 
212 } // namespace CUDF_EXPORT cudf
An immutable, non-owning view of device data as a column of elements that is trivially copyable and u...
Base class for a device table of ColumnDeviceViews.
size_type num_rows() const noexcept
Returns the number of rows.
ColumnDeviceView const & column(size_type column_index) const noexcept
Returns a reference to the view of the specified column.
table_device_view_base(table_device_view_base &&)=default
Move constructor.
ColumnDeviceView * begin() const noexcept
Returns an iterator to the first view in the table.
void destroy()
Destroy the table_device_view object.
table_device_view_base(table_device_view_base const &)=default
Copy constructor.
table_device_view_base(HostTableView source_view, ColumnDeviceView *columns)
Constructor for subclasses to create a table device view from a host table view.
size_type num_columns() const noexcept
Returns the number of columns.
table_device_view_base & operator=(table_device_view_base const &)=default
Copy assignment operator.
ColumnDeviceView * end() const noexcept
Returns an iterator one past the last column view in the table.
table_device_view_base & operator=(table_device_view_base &&)=default
Move assignment operator.
ColumnDeviceView & column(size_type column_index) noexcept
Returns a reference to the view of the specified column.
A mutable, non-owning view of device data as a column of elements that is trivially copyable and usab...
Mutable table device view that is usable in device memory.
static std::unique_ptr< mutable_table_device_view, std::function< void(mutable_table_device_view *)> > create(mutable_table_view source_view, rmm::cuda_stream_view stream=cudf::get_default_stream())
Factory to construct a mutable table device view that is usable in device memory.
A set of mutable_column_views of the same size.
Definition: table_view.hpp:257
Table device view that is usable in device memory.
static std::unique_ptr< table_device_view, std::function< void(table_device_view *)> > create(table_view source_view, rmm::cuda_stream_view stream=cudf::get_default_stream())
Factory to construct a table device view that is usable in device memory.
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:189
Column device 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:84
cuDF interfaces
Definition: host_udf.hpp:26
std::pair< std::unique_ptr< rmm::device_buffer >, ColumnDeviceView * > create_column_device_views(HostTableView source_view, rmm::cuda_stream_view stream)
Copies the contents of a table_view to a column device view in contiguous device memory.
Class definitions for (mutable)_table_view
Type declarations for libcudf.