Skip to content

Commit

Permalink
Update reference page
Browse files Browse the repository at this point in the history
  • Loading branch information
neon60 committed Jul 10, 2024
1 parent 7099433 commit bfe4aff
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -2197,12 +2197,14 @@ INCLUDE_FILE_PATTERNS =
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = "__HIP_PLATFORM_AMD__" \
"DOXYGEN_SHOULD_INCLUDE_THIS=1" \
"DOXYGEN_SHOULD_SKIP_THIS=1" \
"__dparm(x)=" \
"__cplusplus=201103L" \
"__CG_QUALIFIER__=" \
"__CG_STATIC_QUALIFIER__=static" \
"_CG_STATIC_CONST_DECL_=static constexpr"
"_CG_STATIC_CONST_DECL_=static constexpr" \
"HIP_ENABLE_WARP_SYNC_BUILTINS"

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
14 changes: 14 additions & 0 deletions docs/reference/cooperative_groups_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ The following cooperative group classes can be used on the device side.
.. doxygenclass:: cooperative_groups::multi_grid_group
:members:

.. _tiled_group_ref:

.. doxygenclass:: cooperative_groups::tiled_group
:members:

.. _thread_block_tile_type_ref:

.. doxygenclass:: cooperative_groups::thread_block_tile
:members:

.. _coalesced_group_ref:

.. doxygenclass:: cooperative_groups::coalesced_group
Expand All @@ -69,6 +79,10 @@ The following functions are used to construct different group types instances on

.. doxygenfunction:: cooperative_groups::tiled_partition(const thread_group &parent, unsigned int tile_size)

.. doxygenfunction:: cooperative_groups::binary_partition(const coalesced_group& cgrp, bool pred)

.. doxygenfunction:: cooperative_groups::binary_partition(const thread_block_tile<size, parent>& tgrp, bool pred)

Cooperative group exposed API functions
=======================================

Expand Down
4 changes: 2 additions & 2 deletions include/hip/hip_runtime_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -5582,7 +5582,7 @@ hipError_t hipModuleLaunchKernel(hipFunction_t f, unsigned int gridDimX, unsigne
* @param [in] kernelParams A list of kernel arguments.
*
* Please note, HIP does not support kernel launch with total work items defined in dimension with
* size gridDim x blockDim >= 2^32.
* size \f$ gridDim \cdot blockDim \geq 2^{32} \f$.
*
* @returns #hipSuccess, #hipErrorDeinitialized, #hipErrorNotInitialized, #hipErrorInvalidContext,
* #hipErrorInvalidHandle, #hipErrorInvalidImage, #hipErrorInvalidValue,
Expand Down Expand Up @@ -5625,7 +5625,7 @@ hipError_t hipModuleLaunchCooperativeKernelMultiDevice(hipFunctionLaunchParams*
* default stream is used with associated synchronization rules.
*
* Please note, HIP does not support kernel launch with total work items defined in dimension with
* size \f$ gridDim * blockDim >= 2^(32) \f$.
* size \f$ gridDim \cdot blockDim \geq 2^{32} \f$.
*
* @returns #hipSuccess, #hipErrorNotInitialized, #hipErrorInvalidValue, #hipErrorCooperativeLaunchTooLarge
*/
Expand Down

0 comments on commit bfe4aff

Please sign in to comment.