Detailed description

template< typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>
class cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >

A random-access input wrapper for transforming dereferenced values.

Overview

TransformInputIteratorTwraps a unary conversion functor of type ConversionOp and a random-access input iterator of type InputIteratorT, using the former to produce references of type ValueType from the latter.
Can be used with any data type.
Can be constructed, manipulated, and exchanged within and between host and device functions. Wrapped host memory can only be dereferenced on the host, and wrapped device memory can only be dereferenced on the device.
Compatible with Thrust API v1.7 or newer.

Snippet: The code snippet below illustrates the use of TransformInputIteratorTto dereference an array of integers, tripling the values and converting them to doubles.

: #include <cub/cub.cuh> // or equivalently <cub/iterator/transform_input_iterator.cuh>

// Functor for tripling integer values and converting to doubles

struct TripleDoubler

{

__host__ __device__ __forceinline__

double operator()(const int &a) const {

return double(a * 3);

}

};

// Declare, allocate, and initialize a device array

int *d_in; // e.g., [8, 6, 7, 5, 3, 0, 9]

TripleDoubler conversion_op;

// Create an iterator wrapper

cub::TransformInputIterator<double, TripleDoubler, int*> itr(d_in, conversion_op);

// Within device code:

printf("%f\n", itr[0]); // 24.0

printf("%f\n", itr[1]); // 18.0

printf("%f\n", itr[6]); // 27.0

Template Parameters

ValueType	The value type of this iterator
ConversionOp	Unary functor type for mapping objects of type `InputType` to type `ValueType`. Must have member `ValueType operator()(const InputType &datum)`.
InputIteratorT	The type of the wrapped input iterator
OffsetT	The difference type of this iterator (Default: `ptrdiff_t`)

Public Types
typedef TransformInputIterator	self_type
	My own type. More...

typedef OffsetT	difference_type
	Type to express the result of subtracting one iterator from another. More...

typedef ValueType	value_type
	The type of the element the iterator can point to. More...

typedef ValueType *	pointer
	The type of a pointer to an element the iterator can point to. More...

typedef ValueType	reference
	The type of a reference to an element the iterator can point to. More...

typedef std::random_access_iterator_tag	iterator_category
	The iterator category. More...

Public Methods
__host__ __device__ __forceinline__	TransformInputIterator (InputIteratorT input_itr, ConversionOp conversion_op)
	Constructor. More...

__host__ __device__ __forceinline__ self_type	operator++ (int)
	Postfix increment. More...

__host__ __device__ __forceinline__ self_type	operator++ ()
	Prefix increment. More...

__host__ __device__ __forceinline__ reference	operator* () const
	Indirection. More...

template<typename Distance >
__host__ __device__ __forceinline__ self_type	operator+ (Distance n) const
	Addition. More...

template<typename Distance >
__host__ __device__ __forceinline__ self_type &	operator+= (Distance n)
	Addition assignment. More...

template<typename Distance >
__host__ __device__ __forceinline__ self_type	operator- (Distance n) const
	Subtraction. More...

template<typename Distance >
__host__ __device__ __forceinline__ self_type &	operator-= (Distance n)
	Subtraction assignment. More...

__host__ __device__ __forceinline__ difference_type	operator- (self_type other) const
	Distance. More...

template<typename Distance >
__host__ __device__ __forceinline__ reference	operator[] (Distance n) const
	Array subscript. More...

__host__ __device__ __forceinline__ bool	operator== (const self_type &rhs)
	Equal to. More...

__host__ __device__ __forceinline__ bool	operator!= (const self_type &rhs)
	Not equal to. More...

Friends
std::ostream &	operator<< (std::ostream &os, const self_type &)
	ostream operator More...

Member Typedef Documentation

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

typedef TransformInputIterator cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::self_type

My own type.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

typedef OffsetT cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::difference_type

Type to express the result of subtracting one iterator from another.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

typedef ValueType cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::value_type

The type of the element the iterator can point to.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

typedef ValueType* cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::pointer

The type of a pointer to an element the iterator can point to.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

typedef ValueType cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::reference

The type of a reference to an element the iterator can point to.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

typedef std::random_access_iterator_tag cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::iterator_category

The iterator category.

Constructor & Destructor Documentation

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::TransformInputIterator	(	InputIteratorT	input_itr,
		ConversionOp	conversion_op
	)

inline

Constructor.

Parameters

input_itr	Input iterator to wrap
conversion_op	Conversion functor to wrap

Member Function Documentation

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ self_type cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator++ ( int )

inline

Postfix increment.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ self_type cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator++ ( )

inline

Prefix increment.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ reference cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator* ( ) const

inline

Indirection.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

template<typename Distance >

__host__ __device__ __forceinline__ self_type cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator+ ( Distance n) const

inline

Addition.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

template<typename Distance >

__host__ __device__ __forceinline__ self_type& cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator+= ( Distance n)

inline

Addition assignment.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

template<typename Distance >

__host__ __device__ __forceinline__ self_type cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator- ( Distance n) const

inline

Subtraction.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

template<typename Distance >

__host__ __device__ __forceinline__ self_type& cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator-= ( Distance n)

inline

Subtraction assignment.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ difference_type cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator- ( self_type other) const

inline

Distance.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

template<typename Distance >

__host__ __device__ __forceinline__ reference cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator[] ( Distance n) const

inline

Array subscript.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ bool cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator== ( const self_type & rhs)

inline

Equal to.

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ bool cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >::operator!= ( const self_type & rhs)

inline

Not equal to.

Friends And Related Function Documentation

template<typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>

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

friend

ostream operator

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

transform_input_iterator.cuh

Detailed description

template< typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t> class cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >

Public Types

Public Methods

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template< typename ValueType, typename ConversionOp, typename InputIteratorT, typename OffsetT = ptrdiff_t>
class cub::TransformInputIterator< ValueType, ConversionOp, InputIteratorT, OffsetT >