thread_group Class Reference

thread_group Class Reference#

HIP Runtime API Reference: cooperative_groups::thread_group Class Reference
cooperative_groups::thread_group Class Reference

The base type of all cooperative group types. More...

#include <amd_hip_cooperative_groups.h>

Inheritance diagram for cooperative_groups::thread_group:
Collaboration diagram for cooperative_groups::thread_group:

Data Structures

struct  _coalesced_info
 
struct  _tiled_info
 

Public Member Functions

__hip_uint32_t num_threads () const
 
__hip_uint32_t size () const
 Total number of threads in the group (alias of num_threads()) More...
 
unsigned int cg_type () const
 Returns the type of the group. More...
 
__hip_uint32_t thread_rank () const
 Rank of the calling thread within [0, num_threads() ). More...
 
bool is_valid () const
 Returns true if the group has not violated any API constraints. More...
 
void sync () const
 Synchronizes the threads in the group. More...
 

Protected Member Functions

 thread_group (internal::group_type type, __hip_uint32_t num_threads=static_cast< __hip_uint64_t >(0), __hip_uint64_t mask=static_cast< __hip_uint64_t >(0))
 

Protected Attributes

__hip_uint32_t _type
 
__hip_uint32_t _num_threads
 Type of the thread_group. More...
 
__hip_uint64_t _mask
 Total number of threads in the thread_group. More...
 
struct cooperative_groups::thread_group::_coalesced_info coalesced_info
 

Friends

class thread_block
 
thread_group this_thread ()
 
thread_group tiled_partition (const thread_group &parent, unsigned int tile_size)
 User-exposed API to partition groups. More...
 

Detailed Description

The base type of all cooperative group types.

Holds the key properties of a constructed cooperative group types object, like the group type, its size, etc.

Note
Cooperative groups feature is implemented on Linux, under development on Microsoft Windows.

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