A random-access iterator which discards values assigned to it upon dereference. More...

Public Types
using	value_type = discard_value
	The type of the value that can be obtained by dereferencing the iterator.

using	reference = discard_value
	A reference type of the type iterated over (`value_type`).

using	pointer = discard_value *
	A pointer type of the type iterated over (`value_type`).

using	difference_type = std::ptrdiff_t
	A type used for identify distance between iterators.

using	iterator_category = std::random_access_iterator_tag
	The category of the iterator.

Public Member Functions
ROCPRIM_HOST_DEVICE	discard_iterator (size_t index=0)
	Creates a new discard_iterator. More...

ROCPRIM_HOST_DEVICE discard_iterator &	operator++ ()

ROCPRIM_HOST_DEVICE discard_iterator	operator++ (int)

ROCPRIM_HOST_DEVICE discard_iterator &	operator-- ()

ROCPRIM_HOST_DEVICE discard_iterator	operator-- (int)

ROCPRIM_HOST_DEVICE discard_value	operator* () const

ROCPRIM_HOST_DEVICE discard_value	operator[] (difference_type distance) const

ROCPRIM_HOST_DEVICE discard_iterator	operator+ (difference_type distance) const

ROCPRIM_HOST_DEVICE discard_iterator &	operator+= (difference_type distance)

ROCPRIM_HOST_DEVICE discard_iterator	operator- (difference_type distance) const

ROCPRIM_HOST_DEVICE discard_iterator &	operator-= (difference_type distance)

ROCPRIM_HOST_DEVICE difference_type	operator- (discard_iterator other) const

ROCPRIM_HOST_DEVICE bool	operator== (discard_iterator other) const

ROCPRIM_HOST_DEVICE bool	operator!= (discard_iterator other) const

ROCPRIM_HOST_DEVICE bool	operator< (discard_iterator other) const

ROCPRIM_HOST_DEVICE bool	operator<= (discard_iterator other) const

ROCPRIM_HOST_DEVICE bool	operator> (discard_iterator other) const

ROCPRIM_HOST_DEVICE bool	operator>= (discard_iterator other) const

Friends
std::ostream &	operator<< (std::ostream &os, const discard_iterator &)

Detailed Description

A random-access iterator which discards values assigned to it upon dereference.

Overview

discard_iterator does not have any underlying array (memory) and does not save values written to it upon dereference.
discard_iterator can be used to safely ignore certain output of algorithms, which saves memory capacity and/or bandwidth.

Constructor & Destructor Documentation

ROCPRIM_HOST_DEVICE discard_iterator::discard_iterator ( size_t index = 0 )

inline

Parameters

index - optional index of discard iterator (default = 0).

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