Skip to content

Commit a67faad

Browse files
authored
oneMKL: replace unsupported sycl::vector_class with std:vector in USM API (#381)
1 parent fbebf32 commit a67faad

205 files changed

Lines changed: 290 additions & 287 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

source/elements/oneMKL/source/architecture/api_design.inc.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ oneMKL uses the following DPC++ data types:
6363
* SYCL buffer ``sycl::buffer`` for buffer-based memory access. See :ref:`onemkl_buffers` for more details.
6464
* Unified Shared Memory (USM) for pointer-based memory access. See :ref:`onemkl_usm` for more details.
6565
* SYCL event ``sycl::event`` for output event synchronization in oneMKL routines with USM pointers. See :ref:`onemkl_synchronization_with_usm` for more details.
66-
* Vector of SYCL events ``sycl::vector_class<sycl::event>`` for input events synchronization in oneMKL routines with USM pointers. See :ref:`onemkl_synchronization_with_usm` for more details.
66+
* Vector of SYCL events ``std::vector<sycl::event>`` for input events synchronization in oneMKL routines with USM pointers. See :ref:`onemkl_synchronization_with_usm` for more details.
67+
68+
.. note::
69+
The class ``sycl::vector_class`` has been removed from SYCL 2020 and the standard class ``std::vector`` should be used instead for vector of SYCL events in oneMKL routines with USM pointers
6770

6871
.. _onemkl_datatypes:
6972

source/elements/oneMKL/source/architecture/execution_model.inc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ Synchronization When Using USM APIs
7575

7676
When USM pointers are used as input to, or output from, a oneMKL routine, it becomes the calling application's responsibility to manage possible asynchronicity.
7777

78-
To help the calling application, all oneMKL routines with at least one USM pointer argument also take an optional reference to a list of *input events*, of type ``sycl::vector_class<sycl::event>``, and have a return value of type ``sycl::event`` representing computation completion::
78+
To help the calling application, all oneMKL routines with at least one USM pointer argument also take an optional reference to a list of *input events*, of type ``std::vector<sycl::event>``, and have a return value of type ``sycl::event`` representing computation completion::
7979

80-
sycl::event mkl::domain::routine(..., sycl::vector_class<sycl::event> &in_events = {});
80+
sycl::event mkl::domain::routine(..., std::vector<sycl::event> &in_events = {});
8181

8282
The routine shall ensure that all input events (if the list is present and non-empty) have occurred before any USM pointers are accessed. Likewise, the routine's output event shall not be complete until the routine has finished accessing all USM pointer arguments.
8383

source/elements/oneMKL/source/domains/blas/asum.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ asum (USM Version)
127127
const T *x,
128128
std::int64_t incx,
129129
T_res *result,
130-
const sycl::vector_class<sycl::event> &dependencies = {})
130+
const std::vector<sycl::event> &dependencies = {})
131131
}
132132
.. code-block:: cpp
133133
@@ -137,7 +137,7 @@ asum (USM Version)
137137
const T *x,
138138
std::int64_t incx,
139139
T_res *result,
140-
const sycl::vector_class<sycl::event> &dependencies = {})
140+
const std::vector<sycl::event> &dependencies = {})
141141
}
142142
143143
.. container:: section

source/elements/oneMKL/source/domains/blas/axpy.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ axpy (USM Version)
141141
std::int64_t incx,
142142
T *y,
143143
std::int64_t incy,
144-
const sycl::vector_class<sycl::event> &dependencies = {})
144+
const std::vector<sycl::event> &dependencies = {})
145145
}
146146
.. code-block:: cpp
147147
@@ -153,7 +153,7 @@ axpy (USM Version)
153153
std::int64_t incx,
154154
T *y,
155155
std::int64_t incy,
156-
const sycl::vector_class<sycl::event> &dependencies = {})
156+
const std::vector<sycl::event> &dependencies = {})
157157
}
158158
159159
.. container:: section

source/elements/oneMKL/source/domains/blas/axpy_batch.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
212212
std::int64_t *incy,
213213
std::int64_t group_count,
214214
std::int64_t *group_size,
215-
const sycl::vector_class<sycl::event> &dependencies = {})
215+
const std::vector<sycl::event> &dependencies = {})
216216
}
217217
.. code-block:: cpp
218218
@@ -226,7 +226,7 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
226226
std::int64_t *incy,
227227
std::int64_t group_count,
228228
std::int64_t *group_size,
229-
const sycl::vector_class<sycl::event> &dependencies = {})
229+
const std::vector<sycl::event> &dependencies = {})
230230
}
231231
232232
.. container:: section
@@ -300,7 +300,7 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
300300
std::int64_t incy,
301301
std::int64_t stridey,
302302
std::int64_t batch_size,
303-
const sycl::vector_class<sycl::event> &dependencies = {})
303+
const std::vector<sycl::event> &dependencies = {})
304304
}
305305
.. code-block:: cpp
306306
@@ -315,7 +315,7 @@ The total number of vectors in ``x`` and ``y`` are given by the ``batch_size`` p
315315
std::int64_t incy,
316316
std::int64_t stridey,
317317
std::int64_t batch_size,
318-
const sycl::vector_class<sycl::event> &dependencies = {})
318+
const std::vector<sycl::event> &dependencies = {})
319319
}
320320
321321
.. container:: section

source/elements/oneMKL/source/domains/blas/copy.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ copy (USM Version)
126126
std::int64_t incx,
127127
T *y,
128128
std::int64_t incy,
129-
const sycl::vector_class<sycl::event> &dependencies = {})
129+
const std::vector<sycl::event> &dependencies = {})
130130
}
131131
.. code-block:: cpp
132132
@@ -137,7 +137,7 @@ copy (USM Version)
137137
std::int64_t incx,
138138
T *y,
139139
std::int64_t incy,
140-
const sycl::vector_class<sycl::event> &dependencies = {})
140+
const std::vector<sycl::event> &dependencies = {})
141141
}
142142
143143
.. container:: section

source/elements/oneMKL/source/domains/blas/dot.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ dot (USM Version)
142142
const T *y,
143143
std::int64_t incy,
144144
T_res *result,
145-
const sycl::vector_class<sycl::event> &dependencies = {})
145+
const std::vector<sycl::event> &dependencies = {})
146146
}
147147
.. code-block:: cpp
148148
@@ -154,7 +154,7 @@ dot (USM Version)
154154
const T *y,
155155
std::int64_t incy,
156156
T_res *result,
157-
const sycl::vector_class<sycl::event> &dependencies = {})
157+
const std::vector<sycl::event> &dependencies = {})
158158
}
159159
160160
.. container:: section

source/elements/oneMKL/source/domains/blas/dotc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ dotc (USM Version)
130130
const T *y,
131131
std::int64_t incy,
132132
T *result,
133-
const sycl::vector_class<sycl::event> &dependencies = {})
133+
const std::vector<sycl::event> &dependencies = {})
134134
}
135135
.. code-block:: cpp
136136
@@ -142,7 +142,7 @@ dotc (USM Version)
142142
const T *y,
143143
std::int64_t incy,
144144
T *result,
145-
const sycl::vector_class<sycl::event> &dependencies = {})
145+
const std::vector<sycl::event> &dependencies = {})
146146
}
147147
148148
.. container:: section

source/elements/oneMKL/source/domains/blas/dotu.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ dotu (USM Version)
130130
const T *y,
131131
std::int64_t incy,
132132
T *result,
133-
const sycl::vector_class<sycl::event> &dependencies = {})
133+
const std::vector<sycl::event> &dependencies = {})
134134
}
135135
.. code-block:: cpp
136136
@@ -142,7 +142,7 @@ dotu (USM Version)
142142
const T *y,
143143
std::int64_t incy,
144144
T *result,
145-
const sycl::vector_class<sycl::event> &dependencies = {})
145+
const std::vector<sycl::event> &dependencies = {})
146146
}
147147
148148
.. container:: section

source/elements/oneMKL/source/domains/blas/gbmv.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ gbmv (USM Version)
203203
T beta,
204204
T *y,
205205
std::int64_t incy,
206-
const sycl::vector_class<sycl::event> &dependencies = {})
206+
const std::vector<sycl::event> &dependencies = {})
207207
}
208208
.. code-block:: cpp
209209
@@ -222,7 +222,7 @@ gbmv (USM Version)
222222
T beta,
223223
T *y,
224224
std::int64_t incy,
225-
const sycl::vector_class<sycl::event> &dependencies = {})
225+
const std::vector<sycl::event> &dependencies = {})
226226
}
227227
228228
.. container:: section

0 commit comments

Comments
 (0)