table.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2025, NVIDIA CORPORATION.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
18 #include <cudf/column/column.hpp>
22 
23 #include <rmm/cuda_stream_view.hpp>
24 
25 #include <memory>
26 #include <vector>
27 
33 namespace CUDF_EXPORT cudf {
34 
40 class table {
41  public:
42  table() = default;
43  ~table() = default;
44  table(table&&) = default;
45  table& operator=(table const&) = delete;
46  table& operator=(table&&) = delete;
47 
58  explicit table(table const& other,
68  table(std::vector<std::unique_ptr<column>>&& columns);
69 
80 
86  [[nodiscard]] size_type num_columns() const noexcept { return _columns.size(); }
87 
93  [[nodiscard]] size_type num_rows() const noexcept { return _num_rows; }
94 
102  [[nodiscard]] std::size_t alloc_size() const;
103 
110  [[nodiscard]] table_view view() const;
111 
116  operator table_view() const { return this->view(); };
117 
125 
130  operator mutable_table_view() { return this->mutable_view(); };
131 
140  std::vector<std::unique_ptr<column>> release();
141 
154  template <typename InputIterator>
155  [[nodiscard]] table_view select(InputIterator begin, InputIterator end) const
156  {
157  std::vector<column_view> columns(std::distance(begin, end));
159  begin, end, columns.begin(), [this](auto index) { return _columns.at(index)->view(); });
160  return table_view{columns};
161  }
162 
173  [[nodiscard]] table_view select(std::vector<cudf::size_type> const& column_indices) const
174  {
175  return select(column_indices.begin(), column_indices.end());
176  };
177 
187  column& get_column(cudf::size_type column_index) { return *(_columns.at(column_index)); }
188 
198  [[nodiscard]] column const& get_column(cudf::size_type i) const { return *(_columns.at(i)); }
199 
200  private:
201  std::vector<std::unique_ptr<column>> _columns{};
202  size_type _num_rows{};
203 };
204 
205 } // namespace CUDF_EXPORT cudf
A container of nullable device data as a column of elements.
Definition: column.hpp:47
A set of mutable_column_views of the same size.
Definition: table_view.hpp:268
A set of cudf::column_view's of the same size.
Definition: table_view.hpp:200
A set of cudf::column's of the same size.
Definition: table.hpp:40
mutable_table_view mutable_view()
Returns a mutable, non-owning mutable_table_view of the contents of this table.
std::vector< std::unique_ptr< column > > release()
Releases ownership of the columns by returning a vector of unique_ptrs to the constituent columns.
table_view select(std::vector< cudf::size_type > const &column_indices) const
Returns a table_view with set of specified columns.
Definition: table.hpp:173
column const & get_column(cudf::size_type i) const
Returns a const reference to the specified column.
Definition: table.hpp:198
table(table const &other, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Construct a new table by copying the contents of another table.
table_view view() const
Returns an immutable, non-owning table_view of the contents of this table.
table(std::vector< std::unique_ptr< column >> &&columns)
Moves the contents from a vector of unique_ptrs to columns to construct a new table.
size_type num_rows() const noexcept
Returns the number of rows.
Definition: table.hpp:93
table(table &&)=default
Move constructor.
table_view select(InputIterator begin, InputIterator end) const
Returns a table_view built from a range of column indices.
Definition: table.hpp:155
table(table_view view, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Copy the contents of a table_view to construct a new table.
size_type num_columns() const noexcept
Returns the number of columns in the table.
Definition: table.hpp:86
std::size_t alloc_size() const
Returns the total device allocation size of the table's columns in bytes.
column & get_column(cudf::size_type column_index)
Returns a reference to the specified column.
Definition: table.hpp:187
Class definition for cudf::column.
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
std::unique_ptr< column > transform(std::vector< column_view > const &inputs, std::string const &transform_udf, data_type output_type, bool is_ptx, std::optional< void * > user_data=std::nullopt, rmm::cuda_stream_view stream=cudf::get_default_stream(), rmm::device_async_resource_ref mr=cudf::get_current_device_resource_ref())
Creates a new column by applying a transform function against every element of the input columns.
int32_t size_type
Row index type for columns and tables.
Definition: types.hpp:95
size_type distance(T f, T l)
Similar to std::distance but returns cudf::size_type and performs static_cast
Definition: types.hpp:110
cuDF interfaces
Definition: host_udf.hpp:37
Class definitions for (mutable)_table_view