added documentation for IndexLayout #1583
Conversation
gberg617
requested review from
rhornung67,
MrBurmark,
rchen20,
artv3,
adayton1 and
kab163
gberg617
force-pushed
the
feature/bergel1/index-view-documentation
branch
from
a5fe48b to
d18558a
Compare
| Index Layout | ||
| ^^^^^^^^^^^^ | ||
|
|
||
| ``RAJA::IndexLayout`` is a layout that uses an indexing strategy for each |
There was a problem hiding this comment.
| ``RAJA::IndexLayout`` is a layout that uses an indexing strategy for each | |
| ``RAJA::IndexLayout`` is a layout that potentially uses a different indexing strategy for each | |
In reality, all RAJA Layouts use an "index strategy" to index into an array of data. The distinguishing characteristic of IndexLayout is the fact that the indexing can be different for each dimension, correct?
There was a problem hiding this comment.
I think the distinguishing feature should actually be that it can use an index list (or lists) that map input indices to some entry in a view. I don't really think that the fact that you can assign different indexing 'strategies' for each dimension is the central point here. I tried rewording this paragraph to convey that.
There was a problem hiding this comment.
I agree that is the main thing. Having to set one for each dimension is not something you had to do before though so it seems noteworthy as well.
There was a problem hiding this comment.
I re-worded the first paragraph to convey both of the above points. Let me know if you think more clarification or elaboration on those main points is needed.
gberg617
force-pushed
the
feature/bergel1/index-view-documentation
branch
from
dcc9bd2 to
d73db63
Compare
…ndexLayout unit test
Co-authored-by: Jason Burmark <MrBurmark@users.noreply.github.com>
gberg617
force-pushed
the
feature/bergel1/index-view-documentation
branch
from
c13399d to
dbaa1c3
Compare
This PR is for documenting the IndexLayout.