OpenFPM_pdata  4.1.0
Project that contain the implementation of distributed structures
cub::CacheModifiedOutputIterator< MODIFIER, ValueType, OffsetT > Class Template Reference

A random-access output wrapper for storing array values using a PTX cache-modifier. More...

Detailed Description

template<CacheStoreModifier MODIFIER, typename ValueType, typename OffsetT = ptrdiff_t>
class cub::CacheModifiedOutputIterator< MODIFIER, ValueType, OffsetT >

A random-access output wrapper for storing array values using a PTX cache-modifier.

Overview
  • CacheModifiedOutputIterator is a random-access output iterator that wraps a native device pointer of type ValueType*. ValueType references are made by writing ValueType values through stores modified by MODIFIER.
  • Can be used to store any data type to memory using PTX cache store modifiers (e.g., "STORE_WB", "STORE_CG", "STORE_CS", "STORE_WT", etc.).
  • Can be constructed, manipulated, and exchanged within and between host and device functions, but can only be dereferenced within device functions.
  • Compatible with Thrust API v1.7 or newer.
Snippet
The code snippet below illustrates the use of CacheModifiedOutputIterator to dereference a device array of doubles using the "wt" PTX load modifier (i.e., write-through to system memory).
#include <cub/cub.cuh> // or equivalently <cub/iterator/cache_modified_output_iterator.cuh>
// Declare, allocate, and initialize a device array
double *d_out; // e.g., [, , , , , , ]
// Create an iterator wrapper
// Within device code:
itr[0] = 8.0;
itr[1] = 66.0;
itr[55] = 24.0;
Usage Considerations
  • Can only be dereferenced within device code
Template Parameters
CacheStoreModifierThe cub::CacheStoreModifier to use when accessing data
ValueTypeThe value type of this iterator
OffsetTThe difference type of this iterator (Default: ptrdiff_t)

Definition at line 109 of file cache_modified_output_iterator.cuh.

Data Structures

struct  Reference
 

Public Types

typedef CacheModifiedOutputIterator self_type
 My own type.
 
typedef OffsetT difference_type
 Type to express the result of subtracting one iterator from another.
 
typedef void value_type
 The type of the element the iterator can point to.
 
typedef void pointer
 The type of a pointer to an element the iterator can point to.
 
typedef Reference 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

template<typename QualifiedValueType >
__host__ __device__ __forceinline__ CacheModifiedOutputIterator (QualifiedValueType *ptr)
 Constructor. More...
 
__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_typeoperator+= (Distance n)
 Addition assignment.
 
template<typename Distance >
__host__ __device__ __forceinline__ self_type operator- (Distance n) const
 Subtraction.
 
template<typename Distance >
__host__ __device__ __forceinline__ self_typeoperator-= (Distance n)
 Subtraction assignment.
 
__host__ __device__ __forceinline__ difference_type operator- (self_type other) const
 Distance.
 
template<typename Distance >
__host__ __device__ __forceinline__ reference operator[] (Distance n) const
 Array subscript.
 
__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 * ptr
 

Friends

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

Constructor & Destructor Documentation

◆ CacheModifiedOutputIterator()

template<CacheStoreModifier MODIFIER, typename ValueType, typename OffsetT = ptrdiff_t>
template<typename QualifiedValueType >
__host__ __device__ __forceinline__ cub::CacheModifiedOutputIterator< MODIFIER, ValueType, OffsetT >::CacheModifiedOutputIterator ( QualifiedValueType *  ptr)
inline

Constructor.

Parameters
ptrNative pointer to wrap

Definition at line 158 of file cache_modified_output_iterator.cuh.


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