multi_grid_group Class Reference

multi_grid_group Class Reference#

HIP Runtime API Reference: cooperative_groups::multi_grid_group Class Reference
cooperative_groups::multi_grid_group Class Reference

The multi-grid cooperative group type. More...

#include <amd_hip_cooperative_groups.h>

Inheritance diagram for cooperative_groups::multi_grid_group:
[legend]
Collaboration diagram for cooperative_groups::multi_grid_group:
[legend]

Public Member Functions

uint32_t num_grids ()
 
uint32_t grid_rank ()
 
uint32_t thread_rank () const
 Rank of the calling thread within [0, size() ).
 
bool is_valid () const
 Returns true if the group has not violated any API constraints.
 
void sync () const
 Synchronizes the threads in the group.
 
- Public Member Functions inherited from cooperative_groups::thread_group
uint32_t size () const
 
unsigned int cg_type () const
 Returns the type of the group.
 
uint32_t thread_rank () const
 Rank of the calling thread within [0, size() ).
 
bool is_valid () const
 Returns true if the group has not violated any API constraints.
 
void sync () const
 Synchronizes the threads in the group.
 

Protected Member Functions

 multi_grid_group (uint32_t size)
 Construct mutli-grid thread group (through the API this_multi_grid())
 
- Protected Member Functions inherited from cooperative_groups::thread_group
 thread_group (internal::group_type type, uint32_t size=static_cast< uint64_t >(0), uint64_t mask=static_cast< uint64_t >(0))
 

Friends

multi_grid_group this_multi_grid ()
 User-exposed API interface to construct grid cooperative group type object - multi_grid_group.
 

Additional Inherited Members

- Protected Attributes inherited from cooperative_groups::thread_group
uint32_t _type
 
uint32_t _size
 Type of the thread_group.
 
uint64_t _mask
 Total number of threads in the tread_group.
 
struct cooperative_groups::thread_group::_coalesced_info coalesced_info
 

Detailed Description

The multi-grid cooperative group type.

Represents an inter-device cooperative group type, where the participating threads within the group span across multiple devices, running the (same) kernel on these devices.

Note
The multi-grid cooperative group type is implemented on Linux, under development on Microsoft Windows.

The documentation for this class was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/clr/hipamd/include/hip/amd_detail/amd_hip_cooperative_groups.h