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.
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 vector
x
.- x
Buffer holding input vector
x
. The buffer must be of size at least (1 + (n
- 1)*abs(incx
)). See Matrix Storage for more details.- incx
Stride of vector
x
.- y
Buffer holding input vector
y
. The buffer must be of size at least (1 + (n
- 1)*abs(incy
)). See Matrix Storage for more details.- incy
Stride of vector
y
.
Output Parameters
- x
Buffer holding updated buffer
x
, that is, the input vectory
.- y
Buffer holding updated buffer
y
, 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 vector
x
.- x
Pointer to the input vector
x
. The array must be of size at least (1 + (n
- 1)*abs(incx
)). See Matrix Storage for more details.- incx
Stride of vector
x
.- y
Pointer to the input vector
y
. The array must be of size at least (1 + (n
- 1)*abs(incy
)). See Matrix Storage for more details.- incy
Stride of vector
y
.- dependencies
List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- x
Pointer to the updated array
x
, that is, the input vectory
.- y
Pointer to the updated array
y
, that is, the input vectorx
.
Return Values
Output event to wait on to ensure computation is complete.
Parent topic: BLAS Level 1 Routines