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

Make the cheat sheet more API-oriented #21

Open
pzehner opened this issue Apr 4, 2024 · 0 comments
Open

Make the cheat sheet more API-oriented #21

pzehner opened this issue Apr 4, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pzehner
Copy link
Member

pzehner commented Apr 4, 2024

For now (i.e. when finalizing #19), the cheat sheet has a style which is not fully descriptive of the API, unlike the OpenMP cheat sheet or the SYCL cheat sheet.

Signatures of functions are incomplete and do not explicit input parameter types. By instance, the signature for a View is:

Kokkos::View<DataType, LayoutType, MemorySpace, MemoryTraits> view("label", numberOfElements);

while in the API doc, the signature is displayed as (without descriptive text):

template <class DataType [, class LayoutType] [, class MemorySpace] [, class MemoryTraits]>
class View;

View()

View(const View<DT, Prop...> &rhs)

View(View &&rhs)

View(const std::string &name, const IntType&... indices)

View(const std::string &name, const array_layout &layout)

View(const AllocProperties &prop, const IntType&... indices)

View(const AllocProperties &prop, const array_layout &layout)

View(pointer_type ptr, const IntType&... indices)

View(pointer_type ptr, const array_layout &layout)

View(const ScratchSpace &space, const IntType&... indices)

View(const ScratchSpace &space, const array_layout &layout)

View(const View<DT, Prop...> &rhs, Args... args)

Obviously, not all signatures should be in the cheat sheet, but we could include the most common ones. The types of the input parameters are explicited, which would be an improvement.

@pzehner pzehner added the enhancement New feature or request label Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant