cub::ConstantInputIterator< ValueType, OffsetT > Class Template Reference

A random-access input generator for dereferencing a sequence of homogeneous values. More...

Detailed Description

template<typename ValueType, typename OffsetT = ptrdiff_t>
class cub::ConstantInputIterator< ValueType, OffsetT >

A random-access input generator for dereferencing a sequence of homogeneous values.

Overview

• Read references to a ConstantInputIteratorTiterator always return the supplied constant of type ValueType.
• Can be used with any data type.
• Can be constructed, manipulated, dereferenced, and exchanged within and between host and device functions.
• Compatible with Thrust API v1.7 or newer.

Snippet

The code snippet below illustrates the use of ConstantInputIteratorTto dereference a sequence of homogeneous doubles.

#include <cub/cub.cuh>   // or equivalently <cub/iterator/constant_input_iterator.cuh>
 
cub::ConstantInputIterator<double> itr(5.0);
 
printf("%f\n", itr[0]);      // 5.0
printf("%f\n", itr[1]);      // 5.0
printf("%f\n", itr[2]);      // 5.0
printf("%f\n", itr[50]);     // 5.0

Template Parameters

ValueType	The value type of this iterator
OffsetT	The difference type of this iterator (Default: ptrdiff_t)

Definition at line 96 of file constant_input_iterator.cuh.

Public Types
typedef ConstantInputIterator	self_type
	My own type.
typedef OffsetT	difference_type
	Type to express the result of subtracting one iterator from another.
typedef ValueType	value_type
	The type of the element the iterator can point to.
typedef ValueType *	pointer
	The type of a pointer to an element the iterator can point to.
typedef ValueType	reference
	The type of a reference to an element the iterator can point to.
typedef std::random_access_iterator_tag	iterator_category
	The iterator category.

Public Member Functions
__host__ __device__ __forceinline__	ConstantInputIterator (ValueType val, OffsetT offset=0)
	Constructor.
__host__ __device__ __forceinline__ self_type	operator++ (int)
	Postfix increment.
__host__ __device__ __forceinline__ self_type	operator++ ()
	Prefix increment.
__host__ __device__ __forceinline__ reference	operator* () const
	Indirection.
template<typename Distance >
__host__ __device__ __forceinline__ self_type	operator+ (Distance n) const
	Addition.
template<typename Distance >
__host__ __device__ __forceinline__ self_type &	operator+= (Distance n)
	Addition assignment.
template<typename Distance >
__host__ __device__ __forceinline__ self_type	operator- (Distance n) const
	Subtraction.
template<typename Distance >
__host__ __device__ __forceinline__ self_type &	operator-= (Distance n)
	Subtraction assignment.
__host__ __device__ __forceinline__ difference_type	operator- (self_type other) const
	Distance.
template<typename Distance >
__host__ __device__ __forceinline__ reference	operator[] (Distance) const
	Array subscript.
__host__ __device__ __forceinline__ pointer	operator-> ()
	Structure dereference.
__host__ __device__ __forceinline__ bool	operator== (const self_type &rhs)
	Equal to.
__host__ __device__ __forceinline__ bool	operator!= (const self_type &rhs)
	Not equal to.

Private Attributes
ValueType	val
OffsetT	offset

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

Member Typedef Documentation

difference_type

template<typename ValueType , typename OffsetT = ptrdiff_t>

typedef OffsetT cub::ConstantInputIterator< ValueType, OffsetT >::difference_type

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

Definition at line 102 of file constant_input_iterator.cuh.

iterator_category

template<typename ValueType , typename OffsetT = ptrdiff_t>

typedef std::random_access_iterator_tag cub::ConstantInputIterator< ValueType, OffsetT >::iterator_category

The iterator category.

Definition at line 116 of file constant_input_iterator.cuh.

pointer

template<typename ValueType , typename OffsetT = ptrdiff_t>

typedef ValueType* cub::ConstantInputIterator< ValueType, OffsetT >::pointer

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

Definition at line 104 of file constant_input_iterator.cuh.

reference

template<typename ValueType , typename OffsetT = ptrdiff_t>

typedef ValueType cub::ConstantInputIterator< ValueType, OffsetT >::reference

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

Definition at line 105 of file constant_input_iterator.cuh.

self_type

template<typename ValueType , typename OffsetT = ptrdiff_t>

typedef ConstantInputIterator cub::ConstantInputIterator< ValueType, OffsetT >::self_type

My own type.

Definition at line 101 of file constant_input_iterator.cuh.

value_type

template<typename ValueType , typename OffsetT = ptrdiff_t>

typedef ValueType cub::ConstantInputIterator< ValueType, OffsetT >::value_type

The type of the element the iterator can point to.

Definition at line 103 of file constant_input_iterator.cuh.

Constructor & Destructor Documentation

ConstantInputIterator()

template<typename ValueType , typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ cub::ConstantInputIterator< ValueType, OffsetT >::ConstantInputIterator ( ValueType  val, OffsetT  offset = 0  )

inline

Constructor.

Parameters

val	Starting value for the iterator instance to report
offset	Base offset

Definition at line 130 of file constant_input_iterator.cuh.

Member Function Documentation

operator!=()

template<typename ValueType , typename OffsetT = ptrdiff_t>

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

inline

Not equal to.

Definition at line 217 of file constant_input_iterator.cuh.

operator*()

template<typename ValueType , typename OffsetT = ptrdiff_t>

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

inline

Indirection.

Definition at line 154 of file constant_input_iterator.cuh.

operator+()

template<typename ValueType , typename OffsetT = ptrdiff_t>

template<typename Distance >

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

inline

Addition.

Definition at line 161 of file constant_input_iterator.cuh.

operator++() [1/2]

template<typename ValueType , typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ self_type cub::ConstantInputIterator< ValueType, OffsetT >::operator++ ( )

inline

Prefix increment.

Definition at line 147 of file constant_input_iterator.cuh.

operator++() [2/2]

template<typename ValueType , typename OffsetT = ptrdiff_t>

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

inline

Postfix increment.

Definition at line 139 of file constant_input_iterator.cuh.

operator+=()

template<typename ValueType , typename OffsetT = ptrdiff_t>

template<typename Distance >

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

inline

Addition assignment.

Definition at line 169 of file constant_input_iterator.cuh.

operator-() [1/2]

template<typename ValueType , typename OffsetT = ptrdiff_t>

template<typename Distance >

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

inline

Subtraction.

Definition at line 177 of file constant_input_iterator.cuh.

operator-() [2/2]

template<typename ValueType , typename OffsetT = ptrdiff_t>

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

inline

Distance.

Definition at line 192 of file constant_input_iterator.cuh.

operator-=()

template<typename ValueType , typename OffsetT = ptrdiff_t>

template<typename Distance >

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

inline

Subtraction assignment.

Definition at line 185 of file constant_input_iterator.cuh.

operator->()

template<typename ValueType , typename OffsetT = ptrdiff_t>

__host__ __device__ __forceinline__ pointer cub::ConstantInputIterator< ValueType, OffsetT >::operator-> ( )

inline

Structure dereference.

Definition at line 205 of file constant_input_iterator.cuh.

operator==()

template<typename ValueType , typename OffsetT = ptrdiff_t>

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

inline

Equal to.

Definition at line 211 of file constant_input_iterator.cuh.

operator[]()

template<typename ValueType , typename OffsetT = ptrdiff_t>

template<typename Distance >

__host__ __device__ __forceinline__ reference cub::ConstantInputIterator< ValueType, OffsetT >::operator[] ( Distance  ) const

inline

Array subscript.

Definition at line 199 of file constant_input_iterator.cuh.

Friends And Related Symbol Documentation

operator<<

template<typename ValueType , typename OffsetT = ptrdiff_t>

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

friend

ostream operator

Definition at line 223 of file constant_input_iterator.cuh.

Field Documentation

offset

template<typename ValueType , typename OffsetT = ptrdiff_t>

OffsetT cub::ConstantInputIterator< ValueType, OffsetT >::offset

private

Definition at line 122 of file constant_input_iterator.cuh.

val

template<typename ValueType , typename OffsetT = ptrdiff_t>

ValueType cub::ConstantInputIterator< ValueType, OffsetT >::val

private

Definition at line 121 of file constant_input_iterator.cuh.

---

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

• openfpm_data/src/util/cuda/cub_old/iterator/constant_input_iterator.cuh