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

Kokkos::Array is fully missing in the wiki #430

Open
fnrizzi opened this issue Jul 3, 2023 · 4 comments
Open

Kokkos::Array is fully missing in the wiki #430

fnrizzi opened this issue Jul 3, 2023 · 4 comments
Assignees

Comments

@fnrizzi
Copy link
Collaborator

fnrizzi commented Jul 3, 2023

i don't see any entry about `Array un less I am missing it.

This relates to #6252

@ajpowelsnl ajpowelsnl self-assigned this Aug 30, 2023
@nliber nliber self-assigned this Aug 31, 2023
@ajpowelsnl
Copy link
Contributor

@nliber has PR in on array functions, and array deduction guides, among others. Can you give us a hand with this, Nevin?

@ajpowelsnl
Copy link
Contributor

QUESTIONS:

  • How to document specializations?
  • Should the specializations be on the same or diff pages?
  • For the three template parameters, how to document examples? Which is to say, as people would use it, or the class as it exists?
    COMMENTS:
  • View of a Kokkos::Array does not have special semantics, which is to say clarify semantics of Kokkos array
  • Document the way the class is implemented, as well as how users should use it
  • Provide warning that this class will change in the not too distant future?
  • Make main page and then subpages for each of the specializations;
  • Kokkos::Array header is not in containers, but put it there in the documentation, and note that the header is not in containers (because not device-construct-able)
    • If Array moved out, then might break dependencies in wider Kokkos Core
  • In the near term, get some basic documentation in place, and iterate

@ajpowelsnl
Copy link
Contributor

@nliber - ping; what's the ETA on this work?

@cz4rs
Copy link
Contributor

cz4rs commented Sep 24, 2024

+1
I was recently searching for some Kokkos::Array details and it's definitely still missing 😉

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

No branches or pull requests

4 participants