Skip to content

Commit efac3c2

Browse files
authored
[SYCL][Doc] Modify queue shortcuts extension (intel#2060)
Add generic lambda support description Add range shortcuts description Signed-off-by: Ruslan Arutyunyan <[email protected]>
1 parent 07926eb commit efac3c2

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

sycl/doc/extensions/QueueShortcuts/QueueShortcuts.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ Note: These simplifications do not depend on queue order properties. They apply
1919
include::queue.hpp[]
2020
----
2121

22+
Overloads 4-12 shall support generic lambda as the kernel argument. For overloads 4-9 the generic argument is the `item` with the same dimensions that `range` argument has. For overloads 10-12 the generic argument is the `nd_item` with the same dimensions that `nd_range` argument has.
23+
24+
Overloads 4-6 shall support number or `braced-init-list` as the `range` argument.
Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
11
class queue {
22
public:
3-
...
3+
// ...
44
template <typename KernelName, typename KernelType>
5-
event single_task(KernelType KernelFunc);
5+
event single_task(KernelType KernelFunc); // (1)
66

77
template <typename KernelName, typename KernelType>
8-
event single_task(event DepEvent, KernelType KernelFunc);
8+
event single_task(event DepEvent, KernelType KernelFunc); // (2)
99

1010
template <typename KernelName, typename KernelType>
1111
event single_task(const vector_class<event> &DepEvents,
12-
KernelType KernelFunc);
12+
KernelType KernelFunc); // (3)
1313

1414
template <typename KernelName, typename KernelType, int Dims>
15-
event parallel_for(range<Dims> NumWorkItems, KernelType KernelFunc);
15+
event parallel_for(range<Dims> NumWorkItems, KernelType KernelFunc); // (4)
1616

1717
template <typename KernelName, typename KernelType, int Dims>
1818
event parallel_for(range<Dims> NumWorkItems, event DepEvent,
19-
KernelType KernelFunc);
19+
KernelType KernelFunc); // (5)
2020

2121
template <typename KernelName, typename KernelType, int Dims>
2222
event parallel_for(range<Dims> NumWorkItems,
2323
const vector_class<event> &DepEvents,
24-
KernelType KernelFunc);
24+
KernelType KernelFunc); // (6)
2525

2626
template <typename KernelName, typename KernelType, int Dims>
2727
event parallel_for(range<Dims> NumWorkItems, id<Dims> WorkItemOffset,
28-
KernelType KernelFunc);
28+
KernelType KernelFunc); // (7)
2929

3030
template <typename KernelName, typename KernelType, int Dims>
3131
event parallel_for(range<Dims> NumWorkItems, id<Dims> WorkItemOffset,
32-
event DepEvent, KernelType KernelFunc);
32+
event DepEvent, KernelType KernelFunc); // (8)
3333

3434
template <typename KernelName, typename KernelType, int Dims>
3535
event parallel_for(range<Dims> NumWorkItems, id<Dims> WorkItemOffset,
3636
const vector_class<event> &DepEvents,
37-
KernelType KernelFunc);
37+
KernelType KernelFunc); // (9)
3838

3939
template <typename KernelName, typename KernelType, int Dims>
40-
event parallel_for(nd_range<Dims> ExecutionRange, KernelType KernelFunc);
40+
event parallel_for(nd_range<Dims> ExecutionRange, KernelType KernelFunc); // (10)
4141

4242
template <typename KernelName, typename KernelType, int Dims>
4343
event parallel_for(nd_range<Dims> ExecutionRange, event DepEvent,
44-
KernelType KernelFunc);
44+
KernelType KernelFunc); // (11)
4545

4646
template <typename KernelName, typename KernelType, int Dims>
4747
event parallel_for(nd_range<Dims> ExecutionRange,
4848
const vector_class<event> &DepEvents,
49-
KernelType KernelFunc);
49+
KernelType KernelFunc); // (12)
5050
};

0 commit comments

Comments
 (0)