OpenFPM_pdata  4.1.0
Project that contain the implementation of distributed structures
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Data Fields
cub::DispatchSegmentedRadixSort< IS_DESCENDING, KeyT, ValueT, OffsetIteratorT, OffsetT > Struct Template Reference

< Signed integer type for global offsets More...

Detailed Description

template<bool IS_DESCENDING, typename KeyT, typename ValueT, typename OffsetIteratorT, typename OffsetT>
struct cub::DispatchSegmentedRadixSort< IS_DESCENDING, KeyT, ValueT, OffsetIteratorT, OffsetT >

< Signed integer type for global offsets

Utility class for dispatching the appropriately-tuned kernels for segmented device-wide radix sort

Definition at line 1307 of file dispatch_radix_sort.cuh.

+ Inheritance diagram for cub::DispatchSegmentedRadixSort< IS_DESCENDING, KeyT, ValueT, OffsetIteratorT, OffsetT >:

Data Structures

struct  PassConfig
 PassConfig data structure. More...
 

Public Types

enum  { KEYS_ONLY = (Equals<ValueT, NullType>::VALUE) }
 
- Public Types inherited from cub::DeviceRadixSortPolicy< KeyT, ValueT, OffsetT >
enum  { KEYS_ONLY = (Equals<ValueT, NullType>::VALUE) }
 
typedef If<(sizeof(ValueT) > 4) &&(sizeof(KeyT)< sizeof(ValueT)), ValueT, KeyT >::Type DominantT
 
typedef Policy700 MaxPolicy
 MaxPolicy.
 

Public Member Functions

CUB_RUNTIME_FUNCTION __forceinline__ DispatchSegmentedRadixSort (void *d_temp_storage, size_t &temp_storage_bytes, DoubleBuffer< KeyT > &d_keys, DoubleBuffer< ValueT > &d_values, OffsetT num_items, OffsetT num_segments, OffsetIteratorT d_begin_offsets, OffsetIteratorT d_end_offsets, int begin_bit, int end_bit, bool is_overwrite_okay, cudaStream_t stream, bool debug_synchronous, int ptx_version)
 Constructor.
 
template<typename PassConfigT >
CUB_RUNTIME_FUNCTION __forceinline__ cudaError_t InvokePass (const KeyT *d_keys_in, KeyT *d_keys_out, const ValueT *d_values_in, ValueT *d_values_out, int &current_bit, PassConfigT &pass_config)
 Invoke a three-kernel sorting pass at the current bit.
 
template<typename ActivePolicyT , typename SegmentedKernelT >
CUB_RUNTIME_FUNCTION __forceinline__ cudaError_t InvokePasses (SegmentedKernelT segmented_kernel, SegmentedKernelT alt_segmented_kernel)
 Invocation (run multiple digit passes) More...
 
template<typename ActivePolicyT >
CUB_RUNTIME_FUNCTION __forceinline__ cudaError_t Invoke ()
 Invocation.
 

Static Public Member Functions

CUB_RUNTIME_FUNCTION static __forceinline__ cudaError_t Dispatch (void *d_temp_storage, size_t &temp_storage_bytes, DoubleBuffer< KeyT > &d_keys, DoubleBuffer< ValueT > &d_values, int num_items, int num_segments, OffsetIteratorT d_begin_offsets, OffsetIteratorT d_end_offsets, int begin_bit, int end_bit, bool is_overwrite_okay, cudaStream_t stream, bool debug_synchronous)
 Internal dispatch routine. More...
 

Data Fields

void * d_temp_storage
 [in] Device-accessible allocation of temporary storage. When NULL, the required allocation size is written to temp_storage_bytes and no work is done.
 
size_t & temp_storage_bytes
 [in,out] Reference to size in bytes of d_temp_storage allocation
 
DoubleBuffer< KeyT > & d_keys
 [in,out] Double-buffer whose current buffer contains the unsorted input keys and, upon return, is updated to point to the sorted output keys
 
DoubleBuffer< ValueT > & d_values
 [in,out] Double-buffer whose current buffer contains the unsorted input values and, upon return, is updated to point to the sorted output values
 
OffsetT num_items
 [in] Number of items to sort
 
OffsetT num_segments
 [in] The number of segments that comprise the sorting data
 
OffsetIteratorT d_begin_offsets
 [in] Pointer to the sequence of beginning offsets of length num_segments, such that d_begin_offsets[i] is the first element of the ith data segment in d_keys_* and d_values_*
 
OffsetIteratorT d_end_offsets
 [in] Pointer to the sequence of ending offsets of length num_segments, such that d_end_offsets[i]-1 is the last element of the ith data segment in d_keys_* and d_values_*. If d_end_offsets[i]-1 <= d_begin_offsets[i], the ith is considered empty.
 
int begin_bit
 [in] The beginning (least-significant) bit index needed for key comparison
 
int end_bit
 [in] The past-the-end (most-significant) bit index needed for key comparison
 
cudaStream_t stream
 [in] CUDA stream to launch kernels within. Default is stream0.
 
bool debug_synchronous
 [in] Whether or not to synchronize the stream after every kernel launch to check for errors. Also causes launch configurations to be printed to the console. Default is false.
 
int ptx_version
 [in] PTX version
 
bool is_overwrite_okay
 [in] Whether is okay to overwrite source buffers
 

Member Function Documentation

◆ Dispatch()

template<bool IS_DESCENDING, typename KeyT , typename ValueT , typename OffsetIteratorT , typename OffsetT >
CUB_RUNTIME_FUNCTION static __forceinline__ cudaError_t cub::DispatchSegmentedRadixSort< IS_DESCENDING, KeyT, ValueT, OffsetIteratorT, OffsetT >::Dispatch ( void *  d_temp_storage,
size_t &  temp_storage_bytes,
DoubleBuffer< KeyT > &  d_keys,
DoubleBuffer< ValueT > &  d_values,
int  num_items,
int  num_segments,
OffsetIteratorT  d_begin_offsets,
OffsetIteratorT  d_end_offsets,
int  begin_bit,
int  end_bit,
bool  is_overwrite_okay,
cudaStream_t  stream,
bool  debug_synchronous 
)
inlinestatic

Internal dispatch routine.

Parameters
[in]d_temp_storageDevice-accessible allocation of temporary storage. When NULL, the required allocation size is written to temp_storage_bytes and no work is done.
[in,out]temp_storage_bytesReference to size in bytes of d_temp_storage allocation
[in,out]d_keysDouble-buffer whose current buffer contains the unsorted input keys and, upon return, is updated to point to the sorted output keys
[in,out]d_valuesDouble-buffer whose current buffer contains the unsorted input values and, upon return, is updated to point to the sorted output values
[in]num_itemsNumber of items to sort
[in]num_segmentsThe number of segments that comprise the sorting data
[in]d_begin_offsetsPointer to the sequence of beginning offsets of length num_segments, such that d_begin_offsets[i] is the first element of the ith data segment in d_keys_* and d_values_*
[in]d_end_offsetsPointer to the sequence of ending offsets of length num_segments, such that d_end_offsets[i]-1 is the last element of the ith data segment in d_keys_* and d_values_*. If d_end_offsets[i]-1 <= d_begin_offsets[i], the ith is considered empty.
[in]begin_bitThe beginning (least-significant) bit index needed for key comparison
[in]end_bitThe past-the-end (most-significant) bit index needed for key comparison
[in]is_overwrite_okayWhether is okay to overwrite source buffers
[in]streamCUDA stream to launch kernels within. Default is stream0.
[in]debug_synchronousWhether or not to synchronize the stream after every kernel launch to check for errors. Also causes launch configurations to be printed to the console. Default is false.

Definition at line 1575 of file dispatch_radix_sort.cuh.

◆ InvokePasses()

template<bool IS_DESCENDING, typename KeyT , typename ValueT , typename OffsetIteratorT , typename OffsetT >
template<typename ActivePolicyT , typename SegmentedKernelT >
CUB_RUNTIME_FUNCTION __forceinline__ cudaError_t cub::DispatchSegmentedRadixSort< IS_DESCENDING, KeyT, ValueT, OffsetIteratorT, OffsetT >::InvokePasses ( SegmentedKernelT  segmented_kernel,
SegmentedKernelT  alt_segmented_kernel 
)
inline

Invocation (run multiple digit passes)

< Function type of cub::DeviceSegmentedRadixSortKernel

Parameters
[in]segmented_kernelKernel function pointer to parameterization of cub::DeviceSegmentedRadixSortKernel
[in]alt_segmented_kernelAlternate kernel function pointer to parameterization of cub::DeviceSegmentedRadixSortKernel

Definition at line 1455 of file dispatch_radix_sort.cuh.

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