Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs to use the ROCm standard #418

Merged
merged 37 commits into from
Mar 31, 2023
Merged
Changes from 1 commit
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
ac0e07f
Convert Doxygen doc to Sphinx doc
Jun 14, 2022
3936b41
Update README.md for Sphinx doc
Jun 14, 2022
12ac774
Update README.md for Sphinx doc
Jun 14, 2022
be1a787
Add svg images to regenerate png
Jun 15, 2022
1015f47
Add comments to distinguish images generated from SVG
Jun 15, 2022
101e5f9
Order and organize doc
Jun 15, 2022
d3ba695
Remove the mention to CUB
Jun 15, 2022
ba04941
Correct typo, improve style
Jun 15, 2022
88da112
Add examples to iterators
Jun 15, 2022
2dd4710
Explicit dependencies versions for building doc
Jun 24, 2022
ff538ce
Correct typos
Jun 25, 2022
7768748
Remove SVG image directory
Jun 25, 2022
4532385
Re-enable preprocessing for doxygen
Jun 22, 2022
396ae3a
Fix documentation of template overloaded methods with doxygen groups
Jun 22, 2022
447c968
Simplify macros for Doxygen
Jun 25, 2022
12c820b
Organize conf.py
Jun 25, 2022
2273e4c
Correct typo
Jun 25, 2022
8d9a827
Clean Doxyfile
Jun 25, 2022
d298523
Render function parameters as a HTML list
Jun 25, 2022
4647b43
Simplify custom CSS
Jun 25, 2022
88ea1a1
Remove documentation images
Jun 25, 2022
aa7dd87
Revert deletion of DOXYGEN_SHOULD_SKIP_THIS
Jun 25, 2022
b5834a8
Populate doxygen groups for intrinsics
Jun 25, 2022
b20dd9b
Correct typo
Jun 25, 2022
f301782
Rename ops directories
Jun 25, 2022
91dbf60
Rename filename/title for summary of the ops
Jun 25, 2022
6de8949
Fixed rebase in config.hpp
mfep Mar 20, 2023
a509f04
Updated docs to the ROCm standard
mfep Mar 20, 2023
ebd611a
Updated style and copyright date
mfep Mar 22, 2023
4e8aa40
Removed docs from top-level gitignore
mfep Mar 22, 2023
84a8f76
Removed redundant requirements.txt
mfep Mar 22, 2023
21fa6bf
Updated CHANGELOG.md
mfep Mar 23, 2023
fd3c505
Updated gitignore
mfep Mar 27, 2023
9a57aa9
Updated Changelog.md
mfep Mar 30, 2023
2be4618
Rebase fix
mfep Mar 30, 2023
62663d7
Updated docs/.gitignore
mfep Mar 31, 2023
aa091bc
Added Acknowledgements
mfep Mar 31, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Populate doxygen groups for intrinsics
  • Loading branch information
v01dxyz authored and mfep committed Mar 30, 2023
commit b5834a8e409827e5ada4f871b3d06168880870ea
5 changes: 5 additions & 0 deletions rocprim/include/rocprim/intrinsics/thread.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ unsigned int lane_id()
}

/// \brief Returns flat (linear, 1D) thread identifier in a multidimensional block (tile).
/// \ingroup intrinsicsmodule_flat_id
ROCPRIM_DEVICE ROCPRIM_INLINE
unsigned int flat_block_thread_id()
{
Expand Down Expand Up @@ -143,6 +144,7 @@ unsigned int flat_tile_thread_id()
}

/// \brief Returns warp id in a block (tile).
/// \ingroup intrinsicsmodule_warp_id
ROCPRIM_DEVICE ROCPRIM_INLINE
unsigned int warp_id()
{
Expand All @@ -156,14 +158,17 @@ unsigned int warp_id(unsigned int flat_id)
}

/// \brief Returns warp id in a block (tile). Use template parameters to optimize 1D or 2D kernels.
/// \ingroup intrinsicsmodule_warp_id
template<unsigned int BlockSizeX, unsigned int BlockSizeY, unsigned int BlockSizeZ>
ROCPRIM_DEVICE ROCPRIM_INLINE
unsigned int warp_id()
{
return flat_block_thread_id<BlockSizeX, BlockSizeY, BlockSizeZ>()/device_warp_size();
}


/// \brief Returns flat (linear, 1D) block identifier in a multidimensional grid.
/// \ingroup intrinsicsmodule_flat_id
ROCPRIM_DEVICE ROCPRIM_INLINE
unsigned int flat_block_id()
{
Expand Down