Skip to content

Commit be18b3f

Browse files
committed
Clarify group algorithms don't support iterators
Cherry pick KhronosGroup#723 from main (cherry picked from commit 505a2b6)
1 parent 4844014 commit be18b3f

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

adoc/chapters/programming_interface.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21821,7 +21821,7 @@ reported by [code]#Group::fence_scope#).
2182121821
SYCL provides an algorithms library based on the functions described in Section
2182221822
28 of the {cpp17} specification.
2182321823
The first argument to each function is a <<group>>, and data ranges can be
21824-
described using pointers, iterators or instances of the [code]#multi_ptr# class.
21824+
described using pointers or instances of the [code]#multi_ptr# class.
2182521825
The functions defined in this section are free functions available in the
2182621826
[code]#sycl# namespace.
2182721827

@@ -21842,8 +21842,9 @@ Unless the description of a function says otherwise, how the elements of a range
2184221842
are processed by the work-items in a group is undefined.
2184321843

2184421844
SYCL provides separate functions for algorithms which use the work-items in a
21845-
group to execute an operation over a range of iterators and algorithms which are
21846-
applied to data held directly by the work-items in a group.
21845+
group to execute an operation over a range (specified by a start pointer and an
21846+
end pointer) and algorithms which are applied to data held directly by the
21847+
work-items in a group.
2184721848
An example of the usage of these functions is given below:
2184821849

2184921850
[source,,linenums]
@@ -21888,7 +21889,7 @@ The completion of the algorithm happens before any work-item blocking on the
2188821889
same synchronization point is unblocked.
2188921890

2189021891
_Returns:_ true if [code]#pred# returns true when applied to the result of
21891-
dereferencing any iterator in the range [code]#[first, last)#.
21892+
dereferencing any pointer in the range [code]#[first, last)#.
2189221893
--
2189321894

2189421895
. _Constraints:_ Available only if
@@ -21948,7 +21949,7 @@ The completion of the algorithm happens before any work-item blocking on the
2194821949
same synchronization point is unblocked.
2194921950

2195021951
_Returns:_ true if [code]#pred# returns true when applied to the result of
21951-
dereferencing all iterators in the range [code]#[first, last)#.
21952+
dereferencing all pointers in the range [code]#[first, last)#.
2195221953
--
2195321954

2195421955
. _Constraints:_ Available only if
@@ -22008,7 +22009,7 @@ The completion of the algorithm happens before any work-item blocking on the
2200822009
same synchronization point is unblocked.
2200922010

2201022011
_Returns:_ true if [code]#pred# returns false when applied to the result of
22011-
dereferencing all iterators in the range [code]#[first, last)#.
22012+
dereferencing all pointers in the range [code]#[first, last)#.
2201222013
--
2201322014

2201422015
. _Constraints:_ Available only if
@@ -22214,7 +22215,7 @@ The completion of the algorithm happens before any work-item blocking on the
2221422215
same synchronization point is unblocked.
2221522216

2221622217
_Returns:_ The result of combining the values resulting from dereferencing all
22217-
iterators in the range [code]#[first, last)# using the operator
22218+
pointers in the range [code]#[first, last)# using the operator
2221822219
[code]#binary_op#, where the values are combined according to the generalized
2221922220
sum defined in standard {cpp}.
2222022221
--
@@ -22241,7 +22242,7 @@ The completion of the algorithm happens before any work-item blocking on the
2224122242
same synchronization point is unblocked.
2224222243

2224322244
_Returns:_ The result of combining the values resulting from dereferencing all
22244-
iterators in the range [code]#[first, last)# and the initial value [code]#init#
22245+
pointers in the range [code]#[first, last)# and the initial value [code]#init#
2224522246
using the operator [code]#binary_op#, where the values are combined according to
2224622247
the generalized sum defined in standard {cpp}.
2224722248
--

0 commit comments

Comments
 (0)