rocPRIM
Public Types | Public Member Functions | Friends | List of all members
zip_iterator< IteratorTuple > Class Template Reference

TBD. More...

#include <zip_iterator.hpp>

Public Types

using reference = typename detail::tuple_of_references< IteratorTuple >::type
 A reference type of the type iterated over. More...
 
using value_type = typename detail::tuple_of_values< IteratorTuple >::type
 The type of the value that can be obtained by dereferencing the iterator.
 
using pointer = value_type *
 A pointer type of the type iterated over (value_type).
 
using difference_type = typename std::iterator_traits< typename ::rocprim::tuple_element< 0, IteratorTuple >::type >::difference_type
 A type used for identify distance between iterators. More...
 
using iterator_category = std::random_access_iterator_tag
 The category of the iterator.
 

Public Member Functions

ROCPRIM_HOST_DEVICE zip_iterator (IteratorTuple iterator_tuple)
 Creates a new zip_iterator. More...
 
ROCPRIM_HOST_DEVICE zip_iteratoroperator++ ()
 
ROCPRIM_HOST_DEVICE zip_iterator operator++ (int)
 
ROCPRIM_HOST_DEVICE zip_iteratoroperator-- ()
 
ROCPRIM_HOST_DEVICE zip_iterator operator-- (int)
 
ROCPRIM_HOST_DEVICE reference operator* () const
 
ROCPRIM_HOST_DEVICE pointer operator-> () const
 
ROCPRIM_HOST_DEVICE reference operator[] (difference_type distance) const
 
ROCPRIM_HOST_DEVICE zip_iterator operator+ (difference_type distance) const
 
ROCPRIM_HOST_DEVICE zip_iteratoroperator+= (difference_type distance)
 
ROCPRIM_HOST_DEVICE zip_iterator operator- (difference_type distance) const
 
ROCPRIM_HOST_DEVICE zip_iteratoroperator-= (difference_type distance)
 
ROCPRIM_HOST_DEVICE difference_type operator- (zip_iterator other) const
 
ROCPRIM_HOST_DEVICE bool operator== (zip_iterator other) const
 
ROCPRIM_HOST_DEVICE bool operator!= (zip_iterator other) const
 
ROCPRIM_HOST_DEVICE bool operator< (zip_iterator other) const
 
ROCPRIM_HOST_DEVICE bool operator<= (zip_iterator other) const
 
ROCPRIM_HOST_DEVICE bool operator> (zip_iterator other) const
 
ROCPRIM_HOST_DEVICE bool operator>= (zip_iterator other) const
 

Friends

std::ostream & operator<< (std::ostream &os, const zip_iterator &)
 

Detailed Description

template<class IteratorTuple>
class zip_iterator< IteratorTuple >

TBD.

Overview
  • TBD
Template Parameters
IteratorTuple-

Member Typedef Documentation

◆ difference_type

template<class IteratorTuple>
using zip_iterator< IteratorTuple >::difference_type = typename std::iterator_traits< typename ::rocprim::tuple_element<0, IteratorTuple>::type >::difference_type

A type used for identify distance between iterators.

The difference_type member of zip_iterator is the difference_type of the first of the iterator types in the IteratorTuple argument.

◆ reference

template<class IteratorTuple>
using zip_iterator< IteratorTuple >::reference = typename detail::tuple_of_references<IteratorTuple>::type

A reference type of the type iterated over.

The type of the tuple made of the reference types of the iterator types in the IteratorTuple argument.

Constructor & Destructor Documentation

◆ zip_iterator()

template<class IteratorTuple>
ROCPRIM_HOST_DEVICE zip_iterator< IteratorTuple >::zip_iterator ( IteratorTuple  iterator_tuple)
inline

Creates a new zip_iterator.

Parameters
iterator_tupletuple of iterators

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