Skip to content

Have consistent naming of functions for SYCL, C, and Python API functions #284

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

Closed
diptorupd opened this issue Feb 24, 2021 · 0 comments · Fixed by #378
Closed

Have consistent naming of functions for SYCL, C, and Python API functions #284

diptorupd opened this issue Feb 24, 2021 · 0 comments · Fixed by #378
Assignees

Comments

@diptorupd
Copy link
Contributor

We have some inconsistency across the naming of functions in C API and Python. E.g.,

SYCL Function dpCtl C-API function Python API function
get_info<info::device::driver_version> DPCTLDevice_GetDriverInfo get_driver_version

Each function in C API should be named as DPCTLXXXX_YYYY(), where XXXX is the SYCL class name in camel case and YYYY is a meaningful approximation of the SYCL function name. The function name should be close to the SYCL function name with changes as needed to handle templates. For example, the device class get_info functions should be converted into DPCTLDevice_GetZZZZ, where ZZZZ is the descriptor information type. For the above example of get_info<info::device::driver_version the correct C API name should be DPCTLDevice_GetDriverVersion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants