-
Notifications
You must be signed in to change notification settings - Fork 48
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
Update View documentation #21
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,8 +41,10 @@ Template parameters other than `DataType` are optional, but ordering is enforced | |
### Enums | ||
|
||
* `rank`: rank of the view (i.e. the dimensionality). | ||
* `Rank`: rank of the view (i.e. the dimensionality) (use `rank` instead). | ||
* `rank_dynamic`: number of runtime determined dimensions. | ||
* `reference_type_is_lvalue_reference`: whether the reference type is a C++ lvalue reference. | ||
* `is_hostspace`: whether the view is accesible from the process thread. | ||
|
||
### Typedefs | ||
|
||
|
@@ -73,9 +75,21 @@ Template parameters other than `DataType` are optional, but ordering is enforced | |
|
||
|
||
#### ViewTypes | ||
* `non_const_type`: this view type with all template parameters explicitly defined. | ||
* `const_type`: this view type with all template parameters explicitly defined using a `const` data type. | ||
* `HostMirror`: compatible view type with the same `DataType` and `LayoutType` stored in host accessible memory space. | ||
* `non_const_type`: this view type with all template parameters explicitly defined. | ||
* `host_mirror_type`: compatible view type with the same `DataType` and `LayoutType` stored in host accessible memory space. | ||
* `HostMirror`: compatible view type with the same `DataType` and `LayoutType` stored in host accessible memory space (use `host_mirror_type` instead). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same question about documenting deprecated things |
||
* `uniform_type`: this view type with all template arguments explicitly defined, and brought into a canonical form. | ||
* e.g. 0D and 1D `LayoutLeft` and `LayoutRight` are mapped to the same layout type, and always uses `device_type` as space argument. | ||
* `uniform_const_type`: `uniform_type` with const data type | ||
* `uniform_runtime_type`: as `uniform_type` but without compile time extents. | ||
* `uniform_runtime_const_type`: `uniform_runtime_type` with const data type. | ||
* `uniform_nomemspace_type`: uses unified layout and `AnonymousSpace`. | ||
* `uniform_const_nomemspace_type`: `uniform_nomemspace_type` with const data type. | ||
* `uniform_runtime_nomemspace_type`: uses unified layout, all runtime extents and `AnonymousSpace`. | ||
* `uniform_runtime_const_nomemspace_type`: `uniform_runtime_nomemspace_type` with const data type. | ||
|
||
|
||
|
||
#### Data Handles | ||
* `reference_type`: return type of the view access operators. | ||
|
@@ -129,11 +143,19 @@ Template parameters other than `DataType` are optional, but ordering is enforced | |
### Data Access Functions | ||
|
||
* ```c++ | ||
template<class IntType> | ||
reference_type operator[] (const IntType& i) const | ||
``` | ||
Returns a value of `reference_type` which may or not be referenceable itself. | ||
See notes on `reference_type` for properties of the return type. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Say it is only available for rank-1 views |
||
|
||
* ```c++ | ||
template<class ... IntType> | ||
reference_type operator() (const IntType& ... indices) const | ||
``` | ||
Returns a value of `reference_type` which may or not be referenceable itself. The number of index arguments must match the `rank` of the view. | ||
See notes on `reference_type` for properties of the return type. | ||
* Requires: `sizeof(IntType...)==rank_dynamic()` | ||
* Requires: `sizeof(IntType...)==rank` | ||
|
||
* ```c++ | ||
reference_type access (const IntType& i0=0, ... , const IntType& i7=0) const | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Do you really want to document something we don't want people to use?