copy_batch
Computes a group of
copy
operations.Description
The
copy_batch
routines are batched versions of copy, performing
multiple copy
operations in a single call. Each copy
operation copies one vector to another.copy_batch
supports the following precisions:T |
---|
float |
double |
std::complex<float> |
std::complex<double> |
copy_batch (Buffer Version)
Buffer version of
copy_batch
supports only strided API.Strided API
Strided API operation is defined as:
for i = 0 … batch_size – 1
X and Y are vectors at offset i * stridex and i * stridey in x and y
Y = X
end for
where:
- XandYare vectors
For strided API, all vectors
x
(y
) have same parameters (size, increments) and are stored at constant stridex
(stridey
) from each other.
The x
and y
arrays contain all the input vectors. Total number of vectors in x
and y
are given by batch_size
parameter.Syntax
namespace oneapi::mkl::blas::column_major {
void copy_batch(sycl::queue &queue,
std::int64_t n,
sycl::buffer<T, 1> &x,
std::int64_t incx,
std::int64_t stridex,
sycl::buffer<T, 1> &y,
std::int64_t incy,
std::int64_t stridey,
std::int64_t batch_size)
}
namespace oneapi::mkl::blas::row_major {
void copy_batch(sycl::queue &queue,
std::int64_t n,
sycl::buffer<T, 1> &x,
std::int64_t incx,
std::int64_t stridex,
sycl::buffer<T, 1> &y,
std::int64_t incy,
std::int64_t stridey,
std::int64_t batch_size)
}
Input Parameters
- queue
- The queue where the routine should be executed.
- n
- Number of elements in vectorsXandY.
- x
- Buffer holding input vectorsX. Size of the buffer must be at leastbatch_size*stridex.
- incx
- Stride between two consecutive elements ofXvectors.
- stridex
- Stride between two consecutiveXvectors. Must be at least (1 + (n-1)*abs(incx)). See Matrix Storage for more details.
- y
- Buffer holding input/output vectorsY. Size of the buffer must be at leastbatch_size*stridey.
- incy
- Stride between two consecutive elements ofYvectors.
- stridey
- Stride between two consecutiveYvectors. Must be at least (1 + (n-1)*abs(incy)). See Matrix Storage for more details.
- batch_size
- Number ofcopycomputations to perform. Must be at least zero.
Output Parameters
- y
- Output buffer overwritten bybatch_sizecopyoperations.
copy_batch (USM Version)
USM version of
copy_batch
supports group API and strided API.Group API
Group API operation is defined as:
idx = 0
for i = 0 … group_count – 1
for j = 0 … group_size – 1
X and Y are vectors at x[idx] and y[idx]
Y = X
idx = idx + 1
end for
end for
where:
- XandYare vectors
For group API, each group contains vectors with the same parameters (size and increment).
The
x
and y
arrays contain the pointers for all the input vectors. Total number of vectors in x
and y
are given by:
Syntax
namespace oneapi::mkl::blas::column_major {
sycl::event copy_batch(sycl::queue &queue,
std::int64_t *n,
const T **x,
std::int64_t *incx,
T **y,
std::int64_t *incy,
std::int64_t group_count,
std::int64_t *group_size,
const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event copy_batch(sycl::queue &queue,
std::int64_t *n,
const T **x,
std::int64_t *incx,
T **y,
std::int64_t *incy,
std::int64_t group_count,
std::int64_t *group_size,
const std::vector<sycl::event> &dependencies = {})
}
Input Parameters
- queue
- The queue where the routine should be executed.
- n
- Array ofgroup_countintegers.n[i]specifies number of elements in vectorsXandYfor every vector in groupi.
- x
- Array of pointers to input vectorsXwith sizetotal_batch_count. Size of the array allocated for theXvector of the groupimust be at least (1 + (n[i]– 1)*abs(incx[i])). See Matrix Storage for more details.
- incx
- Array ofgroup_countintegers.incx[i]specifies stride of vectorXin groupi.
- y
- Array of pointers to input/output vectorsYwith sizetotal_batch_count. Size of the array allocated for theYvector of the groupimust be at least (1 + (n[i]– 1)*abs(incy[i])). See Matrix Storage for more details.
- incy
- Array ofgroup_countintegers.incy[i]specifies the stride of vectorYin groupi.
- group_count
- Number of groups. Must be at least zero.
- group_size
- Array ofgroup_countintegers.group_size[i]specifies the number ofcopyoperations in groupi. Each element ingroup_sizemust be at least zero.
- dependencies
- List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- y
- Array of pointers holdingYvectors, overwritten bytotal_batch_countcopyoperations.
Return Values
Output event to wait on to ensure computation is complete.
Examples
An example of how to use USM version of
copy_batch
can be found in oneMKL installation directory, under:examples/dpcpp/blas/source/copy_batch_usm.cpp
Strided API
Strided API operation is defined as:
for i = 0 … batch_size – 1
X and Y are vectors at offset i * stridex and i * stridey in x and y
Y = X
end for
where:
- XandYare vectors
For strided API, all vectors
x
(y
) have same parameters (size, increments) and are stored at constant stridex
(stridey
) from each other.
The x
and y
arrays contain all the input vectors. Total number of vectors in x
and y
are given by batch_size
parameter.Syntax
namespace oneapi::mkl::blas::column_major {
sycl::event copy_batch(sycl::queue &queue,
std::int64_t n,
const T *x,
std::int64_t incx,
std::int64_t stridex,
T *y,
std::int64_t incy,
std::int64_t stridey,
std::int64_t batch_size,
const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event copy_batch(sycl::queue &queue,
std::int64_t n,
const T *x,
std::int64_t incx,
std::int64_t stridex,
T *y,
std::int64_t incy,
std::int64_t stridey,
std::int64_t batch_size,
const std::vector<sycl::event> &dependencies = {})
}
Input Parameters
- queue
- The queue where the routine should be executed.
- n
- Number of elements in vectorsXandY.
- x
- Pointer to input vectorsX. Size of the array must be at leastbatch_size*stridex.
- incx
- Stride between two consecutive elements ofXvectors.
- stridex
- Stride between two consecutiveXvectors. Must be at least (1 + (n-1)*abs(incx)). See Matrix Storage for more details.
- y
- Pointer to input/output vectorsY. Size of the array must be at leastbatch_size*stridey.
- incy
- Stride between two consecutive elements ofYvectors.
- stridey
- Stride between two consecutiveYvectors. Must be at least (1 + (n-1)*abs(incy)). See Matrix Storage for more details.
- batch_size
- Number ofcopycomputations to perform. Must be at least zero.
- dependencies
- List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- y
- Output vectors overwritten bybatch_sizecopyoperations.
Return Values
Output event to wait on to ensure computation is complete.