swap
Swaps a vector with another vector.
Description
Given two vectors of
n
elements, x
and y
, the swap
routines return vectors y
and x
swapped, each replacing the
other. The operation is defined as:
swap
supports the following precisions:T |
---|
float |
double |
std::complex<float> |
std::complex<double> |
swap (Buffer Version)
Syntax
namespace oneapi::mkl::blas::column_major {
void swap(sycl::queue &queue,
std::int64_t n,
sycl::buffer<T,1> &x,
std::int64_t incx,
sycl::buffer<T,1> &y,
std::int64_t incy)
}
namespace oneapi::mkl::blas::row_major {
void swap(sycl::queue &queue,
std::int64_t n,
sycl::buffer<T,1> &x,
std::int64_t incx,
sycl::buffer<T,1> &y,
std::int64_t incy)
}
Input Parameters
- queue
- The queue where the routine should be executed.
- n
- Number of elements in vectorsxandy.
- x
- Buffer holding input vectorx. Size of the buffer must be at least (1 + (n- 1)*abs(incx)). See ref:matrix-storagefor more details.
- incx
- Stride of vectorx.
- y
- Buffer holding input vectory. Size of the buffer must be at least (1 + (n- 1)*abs(incy)). See ref:matrix-storagefor more details.
- incy
- Stride of vectory.
Output Parameters
- x
- Buffer holding updated bufferx, that is, the input vectory.
- y
- Buffer holding updated buffery, that is, the input vectorx.
swap (USM Version)
Syntax
namespace oneapi::mkl::blas::column_major {
sycl::event swap(sycl::queue &queue,
std::int64_t n,
T *x,
std::int64_t incx,
T *y,
std::int64_t incy,
const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event swap(sycl::queue &queue,
std::int64_t n,
T *x,
std::int64_t incx,
T *y,
std::int64_t incy,
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 vectorx. Size of the array must be at least (1 + (n- 1)*abs(incx)). See ref:matrix-storagefor more details.
- incx
- Stride of vectorx.
- y
- Pointer to input vectory. Size of the array must be at least (1 + (n- 1)*abs(incy)). See ref:matrix-storagefor more details.
- incy
- Stride of vectory.
- dependencies
- List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- x
- Pointer to updated arrayx, that is, the input vectory.
- y
- Pointer to updated arrayy, that is, the input vectorx.
Return Values
Output event to wait on to ensure computation is complete.