cudf::detail::optional_accessor< T, Nullate > Struct Template Reference

optional accessor of a column More...

Public Member Functions
	optional_accessor (column_device_view const &_col, Nullate with_nulls)
	Constructor. More...
cuda::std::optional< T >	operator() (cudf::size_type i) const
	Returns a cuda::std::optional of column[i]. More...

Public Attributes
column_device_view const	col
	column view of column in device
Nullate	has_nulls {}
	Indicates if the col should be checked for nulls.

Detailed Description

template<typename T, typename Nullate>
struct cudf::detail::optional_accessor< T, Nullate >

optional accessor of a column

The optional_accessor always returns a cuda::std::optional of column[i]. The validity of the optional is determined by the Nullate parameter which may be one of the following:

• nullate::YES means that the column supports nulls and the optional returned might be valid or invalid.
• nullate::NO means the caller attests that the column has no null values, no checks will occur and cuda::std::optional{column[i]} will be return for each i.
• nullate::DYNAMIC defers the assumption of nullability to runtime and the caller specifies if the column has nulls at runtime. For DYNAMIC{true} the return value will be cuda::std::optional{column[i]} if element i is not null and cuda::std::optional{} if element i is null. For DYNAMIC{false} the return value will always be cuda::std::optional{column[i]}.

Exceptions

cudf::logic_error	if column datatype and template T type mismatch.
cudf::logic_error	if the column is not nullable and with_nulls evaluates to true

Template Parameters

T	The type of elements in the column
Nullate	A cudf::nullate type describing how to check for nulls.

Definition at line 1298 of file column_device_view.cuh.

Constructor & Destructor Documentation

optional_accessor()

template<typename T , typename Nullate >

cudf::detail::optional_accessor< T, Nullate >::optional_accessor ( column_device_view const &  _col, Nullate  with_nulls  )

inline

Constructor.

Parameters

_col	Column on which to iterator over its elements.
with_nulls	Indicates if the col should be checked for nulls.

Definition at line 1307 of file column_device_view.cuh.

Member Function Documentation

operator()()

template<typename T , typename Nullate >

cuda::std::optional<T> cudf::detail::optional_accessor< T, Nullate >::operator() ( cudf::size_type  i ) const

inline

Returns a cuda::std::optional of column[i].

Parameters

i	The index of the element to return

Returns

A cuda::std::optional that contains the value of column[i] is not null. If that element is null, the resulting optional will not contain a value.

Definition at line 1321 of file column_device_view.cuh.

---

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

• column_device_view.cuh