Skip to content

Commit

Permalink
Add note
Browse files Browse the repository at this point in the history
  • Loading branch information
KornevNikita committed Feb 7, 2024
1 parent c869d67 commit 2207f4e
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions sycl/doc/extensions/proposed/sycl_ext_oneapi_root_group.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ std::enable_if_t<(Scope == execution_scope::work_item ||
id<Dimensions>>
get_id() const;
----
_Returns_: An id representing the index of the current group or item at 'Scope'
_Returns_: An id representing the index of the current group or item at `Scope`
hierarchy level within the root_group object.

[source,c++]
Expand All @@ -364,7 +364,7 @@ root_group object.
template <execution_scope Scope>
size_t get_linear_id() const;
----
_Returns_: A linearized number of the current group or item at 'Scope' hierarchy
_Returns_: A linearized number of the current group or item at `Scope` hierarchy
level within the root_group object.

[source,c++]
Expand All @@ -375,7 +375,7 @@ std::enable_if_t<(Scope == execution_scope::work_item ||
range<Dimensions>>
get_range() const;
----
_Returns_: A range representing the number of groups or items of 'Scope'
_Returns_: A range representing the number of groups or items of `Scope`
hierarchy level within the root_group object.

[source,c++]
Expand All @@ -392,9 +392,13 @@ object.
template <execution_scope Scope>
size_t get_linear_range() const;
----
_Returns_: The number of groups or items of 'Scope' hierarchy level within the
_Returns_: The number of groups or items of `Scope` hierarchy level within the
root_group object.

NOTE: Functions accepting `Scope` template parameter accept `Scope` of a lower
hierarchy than `execution_scope::root_group`. Otherwise it results in a
compilation error.


=== Using a `root_group`

Expand Down

0 comments on commit 2207f4e

Please sign in to comment.