Skip to content

Commit 07942fc

Browse files
authored
[SYCL][Doc] Fix enqueue functions spec passing handler by reference ... (#15898)
... always instead of by value sometimes. This fixes a mismatch between implementation and spec.
1 parent 2172d9e commit 07942fc

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

sycl/doc/extensions/experimental/sycl_ext_oneapi_enqueue_functions.asciidoc

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ template <typename KernelName, typename KernelType>
278278
void single_task(sycl::queue q, const KernelType& k);
279279
280280
template <typename KernelName, typename KernelType>
281-
void single_task(sycl::handler h, const KernelType& k);
281+
void single_task(sycl::handler &h, const KernelType& k);
282282
283283
}
284284
----
@@ -298,7 +298,7 @@ template <typename Args...>
298298
void single_task(sycl::queue q, const sycl::kernel& k, Args&&... args);
299299
300300
template <typename Args...>
301-
void single_task(sycl::handler h, const sycl::kernel& k, Args&&... args);
301+
void single_task(sycl::handler &h, const sycl::kernel& k, Args&&... args);
302302
303303
}
304304
----
@@ -328,7 +328,7 @@ void parallel_for(sycl::queue q, sycl::range<Dimensions> r,
328328
329329
template <typename KernelName, int Dimensions,
330330
typename KernelType, typename... Reductions>
331-
void parallel_for(sycl::handler h, sycl::range<Dimensions> r,
331+
void parallel_for(sycl::handler &h, sycl::range<Dimensions> r,
332332
const KernelType& k, Reductions&&... reductions);
333333
334334
}
@@ -357,7 +357,7 @@ void parallel_for(sycl::queue q,
357357
358358
template <typename KernelName, int Dimensions,
359359
typename Properties, typename KernelType, typename... Reductions>
360-
void parallel_for(sycl::handler h,
360+
void parallel_for(sycl::handler &h,
361361
launch_config<sycl::range<Dimensions>, Properties> c,
362362
const KernelType& k, Reductions&&... reductions);
363363
@@ -384,7 +384,7 @@ void parallel_for(sycl::queue q, sycl::range<Dimensions> r,
384384
const sycl::kernel& k, Args&&... args);
385385
386386
template <typename KernelName, int Dimensions, typename... Args>
387-
void parallel_for(sycl::handler h, sycl::range<Dimensions> r,
387+
void parallel_for(sycl::handler &h, sycl::range<Dimensions> r,
388388
const sycl::kernel& k, Args&&... args);
389389
390390
}
@@ -410,7 +410,7 @@ void parallel_for(sycl::queue q,
410410
411411
template <typename KernelName, int Dimensions,
412412
typename Properties, typename... Args>
413-
void parallel_for(sycl::handler h,
413+
void parallel_for(sycl::handler &h,
414414
launch_config<sycl::range<Dimensions>, Properties> c,
415415
const sycl::kernel& k, Args&& args...);
416416
@@ -443,7 +443,7 @@ void nd_launch(sycl::queue q, sycl::nd_range<Dimensions> r,
443443
444444
template <typename KernelName, int Dimensions,
445445
typename KernelType, typename... Reductions>
446-
void nd_launch(sycl::handler h, sycl::nd_range<Dimensions> r,
446+
void nd_launch(sycl::handler &h, sycl::nd_range<Dimensions> r,
447447
const KernelType& k, Reductions&&... reductions);
448448
449449
}
@@ -474,7 +474,7 @@ void nd_launch(sycl::queue q,
474474
template <typename KernelName, int Dimensions,
475475
typename Properties,
476476
typename KernelType, typename... Reductions>
477-
void nd_launch(sycl::handler h,
477+
void nd_launch(sycl::handler &h,
478478
launch_config<sycl::nd_range<Dimensions>, Properties> c,
479479
const KernelType& k, Reductions&&... reductions);
480480
@@ -501,7 +501,7 @@ void nd_launch(sycl::queue q, sycl::nd_range<Dimensions> r,
501501
const sycl::kernel& k, Args&&... args);
502502
503503
template <typename KernelName, int Dimensions, typename... Args>
504-
void nd_launch(sycl::handler h, sycl::nd_range<Dimensions> r,
504+
void nd_launch(sycl::handler &h, sycl::nd_range<Dimensions> r,
505505
const sycl::kernel& k, Args&&... args);
506506
507507
}
@@ -528,7 +528,7 @@ void nd_launch(sycl::queue q,
528528
529529
template <typename KernelName, int Dimensions,
530530
typename Properties, typename... Args>
531-
void nd_launch(sycl::handler h,
531+
void nd_launch(sycl::handler &h,
532532
launch_config<sycl::nd_range<Dimensions>, Properties> c,
533533
const sycl::kernel& k, Args&& args...);
534534
@@ -556,7 +556,7 @@ namespace sycl::ext::oneapi::experimental {
556556
557557
void memcpy(sycl::queue q, void* dest, const void* src, size_t numBytes);
558558
559-
void memcpy(sycl::handler h, void* dest, const void* src, size_t numBytes);
559+
void memcpy(sycl::handler &h, void* dest, const void* src, size_t numBytes);
560560
561561
}
562562
----
@@ -575,7 +575,7 @@ template <typename T>
575575
void copy(sycl::queue q, const T* src, T* dest, size_t count);
576576
577577
template <typename T>
578-
void copy(sycl::handler h, const T* src, T* dest, size_t count);
578+
void copy(sycl::handler &h, const T* src, T* dest, size_t count);
579579
580580
}
581581
----
@@ -592,7 +592,7 @@ namespace sycl::ext::oneapi::experimental {
592592
593593
void memset(sycl::queue q, void* ptr, int value, size_t numBytes);
594594
595-
void memset(sycl::handler h, void* ptr, int value, size_t numBytes);
595+
void memset(sycl::handler &h, void* ptr, int value, size_t numBytes);
596596
597597
}
598598
----
@@ -611,7 +611,7 @@ template <typename T>
611611
void fill(sycl::queue q, T* ptr, const T& pattern, size_t count);
612612
613613
template <typename T>
614-
void fill(sycl::handler h, T* ptr, const T& pattern, size_t count);
614+
void fill(sycl::handler &h, T* ptr, const T& pattern, size_t count);
615615
616616
}
617617
----
@@ -628,7 +628,7 @@ namespace sycl::ext::oneapi::experimental {
628628
629629
void prefetch(sycl::queue q, void* ptr, size_t numBytes);
630630
631-
void prefetch(sycl::handler h, void* ptr, size_t numBytes);
631+
void prefetch(sycl::handler &h, void* ptr, size_t numBytes);
632632
633633
}
634634
----
@@ -645,7 +645,7 @@ namespace sycl::ext::oneapi::experimental {
645645
646646
void mem_advise(sycl::queue q, void* ptr, size_t numBytes, int advice);
647647
648-
void mem_advise(sycl::handler h, void* ptr, size_t numBytes, int advice);
648+
void mem_advise(sycl::handler &h, void* ptr, size_t numBytes, int advice);
649649
650650
}
651651
----
@@ -672,7 +672,7 @@ namespace sycl::ext::oneapi::experimental {
672672
673673
void barrier(sycl::queue q);
674674
675-
void barrier(sycl::handler h);
675+
void barrier(sycl::handler &h);
676676
677677
}
678678
----
@@ -692,7 +692,7 @@ namespace sycl::ext::oneapi::experimental {
692692
693693
void partial_barrier(sycl::queue q, const std::vector<sycl::event>& events);
694694
695-
void partial_barrier(sycl::handler h, const std::vector<sycl::event>& events);
695+
void partial_barrier(sycl::handler &h, const std::vector<sycl::event>& events);
696696
697697
}
698698
----

0 commit comments

Comments
 (0)