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:
Collaboration diagram for cooperative_groups::multi_grid_group:
Public Member Functions | |
| __hip_uint32_t | num_grids () |
| __hip_uint32_t | grid_rank () |
| __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... | |
 Public Member Functions inherited from cooperative_groups::thread_group | |
| __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 | |
| multi_grid_group (__hip_uint32_t size) | |
| Construct multi-grid thread group (through the API this_multi_grid()) More... | |
| Protected Member Functions inherited from cooperative_groups::thread_group | |
| 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)) | |
Friends | |
| multi_grid_group | this_multi_grid () |
User-exposed API interface to construct grid cooperative group type object - multi_grid_group. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from cooperative_groups::thread_group | |
| __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 |
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:
- clr/hipamd/include/hip/amd_detail/amd_hip_cooperative_groups.h