libcudf  24.04.00
Public Types | Public Member Functions | Friends | List of all members
cudf::experimental::row::strong_index_iterator< Index, Underlying > Struct Template Reference

A counting iterator that uses strongly typed indices bound to tables. More...

Inheritance diagram for cudf::experimental::row::strong_index_iterator< Index, Underlying >:

Public Types

using super_t = thrust::iterator_adaptor< strong_index_iterator< Index >, Index >
 The base class.
 

Public Member Functions

constexpr strong_index_iterator (Underlying n)
 Constructs a strong index iterator. More...
 

Friends

class thrust::iterator_core_access
 Allow access to the base class.
 

Detailed Description

template<typename Index, typename Underlying = std::underlying_type_t<Index>>
struct cudf::experimental::row::strong_index_iterator< Index, Underlying >

A counting iterator that uses strongly typed indices bound to tables.

Performing lexicographic or equality comparisons between values in two tables requires the use of strongly typed indices. The strong index types lhs_index_type and rhs_index_type ensure that index values are bound to the correct table, regardless of the order in which these indices are provided to the call operator. This struct and its type aliases lhs_iterator and rhs_iterator provide an interface similar to a counting iterator, with strongly typed values to represent the table indices.

Template Parameters
IndexThe strong index type

Definition at line 101 of file experimental/row_operators.cuh.

Constructor & Destructor Documentation

◆ strong_index_iterator()

template<typename Index , typename Underlying = std::underlying_type_t<Index>>
constexpr cudf::experimental::row::strong_index_iterator< Index, Underlying >::strong_index_iterator ( Underlying  n)
inlineexplicitconstexpr

Constructs a strong index iterator.

Parameters
nThe beginning index

Definition at line 115 of file experimental/row_operators.cuh.


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