18 #include <cudf/detail/offsets_iterator.cuh>
20 #include <cudf/strings/string_view.cuh>
25 #include <cuda/std/optional>
26 #include <cuda/std/type_traits>
29 #include <type_traits>
36 namespace CUDF_EXPORT
cudf {
48 struct YES : cuda::std::true_type {};
49 struct NO : cuda::std::false_type {};
65 constexpr
explicit DYNAMIC(
bool b) noexcept : value{b} {}
127 template <
typename T = void,
128 CUDF_ENABLE_IF(cuda::std::is_same_v<T, void> or is_rep_layout_compatible<T>())>
131 return static_cast<T const*
>(_data);
149 template <typename T, CUDF_ENABLE_IF(is_rep_layout_compatible<T>())>
152 return head<T>() + _offset;
218 return not
nullable() or is_valid_nocheck(element_index);
235 return bit_is_set(_null_mask, offset() + element_index);
269 return not is_valid_nocheck(element_index);
309 : _type{type}, _size{size}, _data{data}, _null_mask{null_mask}, _offset{offset}
313 template <
typename C,
typename T,
typename =
void>
314 struct has_element_accessor_impl : cuda::std::false_type {};
316 template <
typename C,
typename T>
317 struct has_element_accessor_impl<
320 void_t<decltype(cuda::std::declval<C>().template element<T>(cuda::std::declval<size_type>()))>>
321 : cuda::std::true_type {};
325 template <
typename T>
326 struct value_accessor;
327 template <
typename T,
typename Nullate>
328 struct optional_accessor;
329 template <
typename T,
bool has_nulls>
330 struct pair_accessor;
331 template <
typename T,
bool has_nulls>
332 struct pair_rep_accessor;
333 template <
typename T>
334 struct mutable_value_accessor;
397 this->offset() + offset,
399 this->num_child_columns()};
419 template <typename T, CUDF_ENABLE_IF(is_rep_layout_compatible<T>())>
422 return data<T>()[element_index];
436 template <
typename T, CUDF_ENABLE_IF(cuda::std::is_same_v<T,
string_view>)>
439 size_type index = element_index + offset();
440 char const* d_strings =
static_cast<char const*
>(_data);
441 auto const offsets = child(offsets_column_index);
442 auto const itr = cudf::detail::input_offsetalator(offsets.head(), offsets.type());
443 auto const offset = itr[index];
458 template <typename T, CUDF_ENABLE_IF(cudf::is_fixed_point<T>())>
462 using rep =
typename T::rep;
475 return d_children[child_index];
485 return _num_children;
508 : column_device_view_base(type, size, data, null_mask, offset),
509 d_children(children),
510 _num_children(num_children)
565 template <
typename T = void,
566 CUDF_ENABLE_IF(cuda::std::is_same_v<T, void> or is_rep_layout_compatible<T>())>
569 return const_cast<T*
>(detail::column_device_view_base::head<T>());
584 template <typename T, CUDF_ENABLE_IF(is_rep_layout_compatible<T>())>
587 return const_cast<T*
>(detail::column_device_view_base::data<T>());
604 template <typename T, CUDF_ENABLE_IF(is_rep_layout_compatible<T>())>
607 return data<T>()[element_index];
617 template <typename T, CUDF_ENABLE_IF(is_rep_layout_compatible<T>())>
620 data<T>()[element_index] = value;
631 template <typename T, CUDF_ENABLE_IF(is_fixed_point<T>())>
636 using rep =
typename T::rep;
637 data<rep>()[element_index] = value.value();
650 return const_cast<bitmask_type*
>(detail::column_device_view_base::null_mask());
662 return d_children[child_index];
680 __device__ void set_valid(size_type element_index) const noexcept
682 return set_bit(null_mask(), element_index);
698 __device__
void set_null(
size_type element_index)
const noexcept
700 return clear_bit(null_mask(), element_index);
740 : column_device_view_base(type, size, data, null_mask, offset),
741 d_children(children),
742 _num_children(num_children)
773 destination_word_index * detail::size_in_bits<bitmask_type>())) {
774 next_word = source[source_word_index + 1];
776 return __funnelshift_r(curr_word, next_word, source_begin_bit);
Utilities for bit and bitmask operations.
An immutable, non-owning view of device data as a column of elements that is trivially copyable and u...
column_device_view_core(column_device_view_core const &)=default
Copy constructor.
CUDF_HOST_DEVICE size_type num_child_columns() const noexcept
Returns the number of child columns.
T element(size_type element_index) const noexcept
Returns reference to element at the specified index.
column_device_view_core & operator=(column_device_view_core const &)=default
Copy assignment operator.
column_device_view_core(column_device_view_core &&)=default
Move constructor.
CUDF_HOST_DEVICE column_device_view_core slice(size_type offset, size_type size) const noexcept
Get a new raw_column_device_view which is a slice of this column.
CUDF_HOST_DEVICE column_device_view_core(data_type type, size_type size, void const *data, bitmask_type const *null_mask, size_type offset, column_device_view_core *children, size_type num_children)
Creates an instance of this class using pre-existing device memory pointers to data,...
column_device_view_core & operator=(column_device_view_core &&)=default
Move assignment operator.
column_device_view_core(column_view column, void *h_ptr, void *d_ptr)
Creates an instance of this class using the specified host memory pointer (h_ptr) to store child obje...
column_device_view_core child(size_type child_index) const noexcept
Returns the specified child.
A non-owning, immutable view of device data as a column of elements, some of which may be null as ind...
A container of nullable device data as a column of elements.
Indicator for the logical data type of an element in a column.
An immutable, non-owning view of device data as a column of elements that is trivially copyable and u...
CUDF_HOST_DEVICE T const * head() const noexcept
Returns pointer to the base device memory allocation casted to the specified type.
CUDF_HOST_DEVICE data_type type() const noexcept
Returns the element type.
CUDF_HOST_DEVICE column_device_view_base(data_type type, size_type size, void const *data, bitmask_type const *null_mask, size_type offset)
Constructs a column with the specified type, size, data, nullmask and offset.
column_device_view_base & operator=(column_device_view_base &&)=default
Move assignment operator.
CUDF_HOST_DEVICE size_type size() const noexcept
Returns the number of elements in the column.
bitmask_type get_mask_word(size_type word_index) const noexcept
Returns the specified bitmask word from the null_mask().
column_device_view_base(column_device_view_base &&)=default
Move constructor.
column_device_view_base(column_device_view_base const &)=default
Copy constructor.
CUDF_HOST_DEVICE bitmask_type const * null_mask() const noexcept
Returns raw pointer to the underlying bitmask allocation.
bool is_valid_nocheck(size_type element_index) const noexcept
Returns whether the specified element holds a valid value (i.e., not null)
CUDF_HOST_DEVICE T const * data() const noexcept
Returns the underlying data casted to the specified type, plus the offset.
column_device_view_base & operator=(column_device_view_base const &)=default
Copy assignment operator.
bool is_null(size_type element_index) const noexcept
Returns whether the specified element is null.
CUDF_HOST_DEVICE size_type offset() const noexcept
Returns the index of the first element relative to the base memory allocation, i.e....
bool is_null_nocheck(size_type element_index) const noexcept
Returns whether the specified element is null.
CUDF_HOST_DEVICE bool nullable() const noexcept
Indicates whether the column can contain null elements, i.e., if it has an allocated bitmask.
bool is_valid(size_type element_index) const noexcept
Returns whether the specified element holds a valid value (i.e., not null).
A mutable, non-owning view of device data as a column of elements that is trivially copyable and usab...
mutable_column_device_view_core(mutable_column_device_view_core const &)=default
Copy constructor.
mutable_column_device_view_core child(size_type child_index) const noexcept
Returns the specified child.
void assign(size_type element_index, T value) const noexcept
Assigns value to the element at element_index
CUDF_HOST_DEVICE T * data() const noexcept
Returns the underlying data casted to the specified type, plus the offset.
CUDF_HOST_DEVICE mutable_column_device_view_core(data_type type, size_type size, void const *data, bitmask_type const *null_mask, size_type offset, mutable_column_device_view_core *children, size_type num_children)
Creates an instance of this class using pre-existing device memory pointers to data,...
void set_mask_word(size_type word_index, bitmask_type new_word) const noexcept
Updates the specified bitmask word in the null_mask() with a new word.
T & element(size_type element_index) const noexcept
Returns reference to element at the specified index.
CUDF_HOST_DEVICE T * head() const noexcept
Returns pointer to the base device memory allocation casted to the specified type.
mutable_column_device_view_core & operator=(mutable_column_device_view_core const &)=default
Copy assignment operator.
mutable_column_device_view_core & operator=(mutable_column_device_view_core &&)=default
Move assignment operator.
mutable_column_device_view_core(mutable_column_device_view_core &&)=default
Move constructor.
CUDF_HOST_DEVICE bitmask_type * null_mask() const noexcept
Returns raw pointer to the underlying bitmask allocation.
A non-owning, immutable view of device data that is a variable length char array representing a UTF-8...
Class definition for fixed point data type.
scale_type
The scale type for fixed_point.
constexpr CUDF_HOST_DEVICE size_type word_index(size_type bit_index)
Returns the index of the word containing the specified bit.
CUDF_HOST_DEVICE bool bit_is_set(bitmask_type const *bitmask, size_type bit_index)
Indicates whether the specified bit is set to 1
int32_t size_type
Row index type for columns and tables.
uint32_t bitmask_type
Bitmask type stored as 32-bit unsigned integer.
void void_t
Utility metafunction that maps a sequence of any types to the type void.
#define CUDF_ENABLE_IF(...)
Convenience macro for SFINAE as an unnamed template parameter.
bool nullable(table_view const &view)
Returns True if any of the columns in the table is nullable. (not entire hierarchy)
fixed_point and supporting types
nullate::DYNAMIC defers the determination of nullability to run time rather than compile time....
bool value
True if nulls are expected.
constexpr DYNAMIC(bool b) noexcept
Create a runtime nullate object.
Indicates the presence of nulls at compile-time or runtime.
Helper struct for constructing fixed_point when value is already shifted.
Type declarations for libcudf.
#define CUDF_HOST_DEVICE
Indicates that the function or method is usable on host and device.