libcudf  23.12.00
Public Types | Public Member Functions | List of all members
cudf::table_view Class Reference

A set of cudf::column_view's of the same size. More...

#include <table_view.hpp>

Inheritance diagram for cudf::table_view:
cudf::detail::table_view_base< column_view >

Public Types

using ColumnView = column_view
 The type of column view the table contains.
 
- Public Types inherited from cudf::detail::table_view_base< column_view >
using iterator = decltype(std::begin(_columns))
 Iterator type for the table.
 
using const_iterator = decltype(std::cbegin(_columns))
 const iterator type for the table
 

Public Member Functions

 table_view (std::vector< table_view > const &views)
 Construct a table from a vector of table views. More...
 
template<typename InputIterator >
table_view select (InputIterator begin, InputIterator end) const
 Returns a table_view built from a range of column indices. More...
 
table_view select (std::vector< size_type > const &column_indices) const
 Returns a table_view with set of specified columns. More...
 
- Public Member Functions inherited from cudf::detail::table_view_base< column_view >
 table_view_base (std::vector< column_view > const &cols)
 Construct a table from a vector of column views. More...
 
 table_view_base (table_view_base const &)=default
 Copy constructor.
 
 table_view_base (table_view_base &&)=default
 Move constructor.
 
iterator begin () noexcept
 Returns an iterator to the first view in the table. More...
 
const_iterator begin () const noexcept
 Returns an iterator to the first view in the table. More...
 
iterator end () noexcept
 Returns an iterator one past the last column view in the table. More...
 
const_iterator end () const noexcept
 Returns an iterator one past the last column view in the table. More...
 
column_view const & column (size_type column_index) const
 Returns a reference to the view of the specified column. More...
 
size_type num_columns () const noexcept
 Returns the number of columns. More...
 
size_type num_rows () const noexcept
 Returns the number of rows. More...
 
size_type is_empty () const noexcept
 Returns true if num_columns() returns zero, or false otherwise. More...
 
table_view_baseoperator= (table_view_base const &)=default
 Copy assignment operator. More...
 
table_view_baseoperator= (table_view_base &&)=default
 Move assignment operator. More...
 

Detailed Description

A set of cudf::column_view's of the same size.

All public member functions and constructors are inherited from table_view_base<column_view>.

Definition at line 187 of file table_view.hpp.

Constructor & Destructor Documentation

◆ table_view()

cudf::table_view::table_view ( std::vector< table_view > const &  views)

Construct a table from a vector of table views.

Note
Because a std::vector is constructible from a std::initializer_list, this constructor also supports the following usage:
table_view t0, t1, t2;
...
table_view t{{t0,t1,t2}}; // Creates a `table` from the columns of
t0, t1, t2
Exceptions
cudf::logic_errorIf number of rows mismatch
Parameters
viewsThe vector of table views to construct the table from

Member Function Documentation

◆ select() [1/2]

template<typename InputIterator >
table_view cudf::table_view::select ( InputIterator  begin,
InputIterator  end 
) const
inline

Returns a table_view built from a range of column indices.

Exceptions
std::out_of_rangeIf any index is outside [0, num_columns())
Parameters
beginBeginning of the range
endEnding of the range
Returns
A table_view consisting of columns from the original table specified by the elements of column_indices

Definition at line 227 of file table_view.hpp.

◆ select() [2/2]

table_view cudf::table_view::select ( std::vector< size_type > const &  column_indices) const

Returns a table_view with set of specified columns.

Exceptions
std::out_of_rangeIf any element in column_indices is outside [0, num_columns())
Parameters
column_indicesIndices of columns in the table
Returns
A table_view consisting of columns from the original table specified by the elements of column_indices

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