-
Notifications
You must be signed in to change notification settings - Fork 547
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
Docs: Update Math API page #3738
base: docs/develop
Are you sure you want to change the base?
Conversation
a1238f8
to
e9be8fc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, except for the missing data related to the functions that don't run on GPUs.
@adeljo-amd Could you please rebase the branch? |
Done |
01057c5
to
e164839
Compare
@neon60 Updated and added test ranges too |
I find the explanation of ffs() might lack information. ffs() returns 0 if the integer has no bit set to 1. i.e.
Also should we warn that fns() calls are potentially slower? (as the compiler does not have a intrinsic for them, unlike ffs()):
|
@g-h-c These are fair suggestions - it probably won't be necessary to mention that ffs() calls ff1, but it would be good to highlight that fns() is implemented via software rather than via hardware intrinsics. Besides updating the ffs() description, I think it would be good to align this with ffsll(), which I imagine has the same behavior |
@g-h-c Fixed, let me know what you think |
The goal of this PR is to improve the usability of the Math API page, by providing information about each function's maximum ULP error when compared against the C++ standard library (if applicable). It also highlights specific math functions which are unsupported too.